What this read moved
326–350 of 519This capture is too large to show at once. Changes 326-350 of 519 are below, significant first; the rest are on the following screens.
api/beta/organization/users/remove Changed · +9 / -4 lines
from line 1
1---
2title: Remove User
3url: https://platform.claude.com/docs/en/api/beta/organization/users/remove
4---
5
16# Remove User
27
38**DELETE** `/v1/organizations/users/{user_id}`
from line 17
1217
1318## Returns
1419
15- `id: string`
16
17 ID of the User.
18
1920- `type: "user_deleted"`
2021
2122 Deleted object type.
from line 24
2324 For Users, this is always `"user_deleted"`.
2425
2526 default: user_deleted
27
28- `id: string`
29
30 ID of the User.
2631
2732## Example
2833
api/beta/organization/users/retrieve Changed · +13 / -8 lines
from line 1
1---
2title: Get User
3url: https://platform.claude.com/docs/en/api/beta/organization/users/retrieve
4---
5
16# Get User
27
38**GET** `/v1/organizations/users/{user_id}`
from line 19
1419
1520- `BetaOrganizationUser object`
1621
22 - `type: "user"`
23
24 Object type.
25
26 For Users, this is always `"user"`.
27
28 default: user
29
1730 - `id: string`
1831
1932 ID of the User.
from line 66
5366 - `"primary_owner"`
5467
5568 - `"user"`
56
57 - `type: "user"`
58
59 Object type.
60
61 For Users, this is always `"user"`.
62
63 default: user
6469
6570## Example
6671
api/beta/organization/users/update Changed · +13 / -8 lines
from line 1
1---
2title: Update User
3url: https://platform.claude.com/docs/en/api/beta/organization/users/update
4---
5
16# Update User
27
38**POST** `/v1/organizations/users/{user_id}`
from line 37
3237
3338- `BetaOrganizationUser object`
3439
40 - `type: "user"`
41
42 Object type.
43
44 For Users, this is always `"user"`.
45
46 default: user
47
3548 - `id: string`
3649
3750 ID of the User.
from line 84
7184 - `"primary_owner"`
7285
7386 - `"user"`
74
75 - `type: "user"`
76
77 Object type.
78
79 For Users, this is always `"user"`.
80
81 default: user
8287
8388## Example
8489
api/beta/organization/workspaces Changed · +101 / -84 lines
from line 1
1---
2title: Workspaces
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces
4---
5
16# Workspaces
27
38## List Workspaces
from line 39
3439
3540- `data: array of BetaWorkspace`
3641
42 - `type: "workspace"`
43
44 Object type.
45
46 For Workspaces, this is always `"workspace"`.
47
48 default: workspace
49
3750 - `id: string`
3851
3952 ID of the Workspace.
from line 123
110123
111124 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
112125
113 - `type: "workspace"`
114
115 Object type.
116
117 For Workspaces, this is always `"workspace"`.
118
119 default: workspace
120
121126- `first_id: string or null`
122127
123128 First ID in the `data` list. Can be used as the `before_id` for the previous page.
from line 188
183188
184189 - `string`
185190
186 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
191 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
187192
188193 - `"message-batches-2024-09-24"`
189194
from line 236
231236
232237 - `"user-profiles-2026-08-18"`
233238
239 - `"user-profiles-2026-09-04"`
240
234241 - `"advisor-tool-2026-03-01"`
235242
236243 - `"managed-agents-2026-04-01"`
from line 344
337344
338345- `BetaWorkspace object`
339346
347 - `type: "workspace"`
348
349 Object type.
350
351 For Workspaces, this is always `"workspace"`.
352
353 default: workspace
354
340355 - `id: string`
341356
342357 ID of the Workspace.
from line 428
413428
414429 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
415430
416 - `type: "workspace"`
417
418 Object type.
419
420 For Workspaces, this is always `"workspace"`.
421
422 default: workspace
423
424431### Example
425432
426433```bash
from line 486
479486
480487- `BetaWorkspace object`
481488
489 - `type: "workspace"`
490
491 Object type.
492
493 For Workspaces, this is always `"workspace"`.
494
495 default: workspace
496
482497 - `id: string`
483498
484499 ID of the Workspace.
from line 570
555570
556571 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
557572
558 - `type: "workspace"`
559
560 Object type.
561
562 For Workspaces, this is always `"workspace"`.
563
564 default: workspace
565
566573### Example
567574
568575```bash
from line 672
665672
666673- `BetaWorkspace object`
667674
675 - `type: "workspace"`
676
677 Object type.
678
679 For Workspaces, this is always `"workspace"`.
680
681 default: workspace
682
668683 - `id: string`
669684
670685 ID of the Workspace.
from line 756
741756
742757 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
743758
744 - `type: "workspace"`
745
746 Object type.
747
748 For Workspaces, this is always `"workspace"`.
749
750 default: workspace
751
752759### Example
753760
754761```bash
from line 811
804811
805812- `BetaWorkspace object`
806813
814 - `type: "workspace"`
815
816 Object type.
817
818 For Workspaces, this is always `"workspace"`.
819
820 default: workspace
821
807822 - `id: string`
808823
809824 ID of the Workspace.
from line 895
880895
881896 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
882897
883 - `type: "workspace"`
884
885 Object type.
886
887 For Workspaces, this is always `"workspace"`.
888
889 default: workspace
890
891898### Example
892899
893900```bash
from line 1026
10191026
10201027- `BetaWorkspace object`
10211028
1029 - `type: "workspace"`
1030
1031 Object type.
1032
1033 For Workspaces, this is always `"workspace"`.
1034
1035 default: workspace
1036
10221037 - `id: string`
10231038
10241039 ID of the Workspace.
from line 1110
10951110
10961111 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
10971112
1098 - `type: "workspace"`
1099
1100 Object type.
1101
1102 For Workspaces, this is always `"workspace"`.
1103
1104 default: workspace
1105
11061113### Beta Workspace Member
11071114
11081115- `BetaWorkspaceMember object`
from line 1216
12091216
12101217 Rate-limit entries for the workspace, one per group that has at least one override.
12111218
1219 - `type: "workspace_rate_limit"`
1220
1221 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
1222
1223 default: workspace_rate_limit
1224
12121225 - `group_type: "batch" or "files" or "model_group" or 3 more`
12131226
12141227 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`.
from line 1242
12291242
12301243 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
12311244
1232 - `org_limit: number or null`
1233
1234 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
1235
12361245 - `type: string`
12371246
12381247 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
12391248
1249 - `org_limit: number or null`
1250
1251 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
1252
12401253 - `value: number`
12411254
12421255 The workspace-level override value for this limiter type.
from line 1262
12491262
12501263 The `id` of the RateLimit group this override applies to.
12511264
1252 - `type: "workspace_rate_limit"`
1253
1254 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
1255
1256 default: workspace_rate_limit
1257
12581265 - `workspace_id: string`
12591266
12601267 ID of the Workspace this override applies to.
from line 1750
17431750
17441751 - `string`
17451752
1746 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1753 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
17471754
17481755 - `"message-batches-2024-09-24"`
17491756
from line 1798
17911798
17921799 - `"user-profiles-2026-08-18"`
17931800
1801 - `"user-profiles-2026-09-04"`
1802
17941803 - `"advisor-tool-2026-03-01"`
17951804
17961805 - `"managed-agents-2026-04-01"`
from line 1846
18371846
18381847- `data: array of BetaServiceAccountWorkspaceMember`
18391848
1849 - `type: "service_account_workspace_member"`
1850
1851 default: service_account_workspace_member
1852
18401853 - `created_by_actor_id: string or null`
18411854
18421855 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 1862
18491862
18501863 Tagged service account ID (`svac_...`).
18511864
1852 - `type: "service_account_workspace_member"`
1853
1854 default: service_account_workspace_member
1855
18561865 - `workspace_id: string`
18571866
18581867 Tagged workspace ID (`wrkspc_...`).
from line 1941
19321941
19331942 - `string`
19341943
1935 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1944 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
19361945
19371946 - `"message-batches-2024-09-24"`
19381947
from line 1989
19801989
19811990 - `"user-profiles-2026-08-18"`
19821991
1992 - `"user-profiles-2026-09-04"`
1993
19831994 - `"advisor-tool-2026-03-01"`
19841995
19851996 - `"managed-agents-2026-04-01"`
from line 2055
20442055
20452056- `BetaServiceAccountWorkspaceMember object`
20462057
2058 - `type: "service_account_workspace_member"`
2059
2060 default: service_account_workspace_member
2061
20472062 - `created_by_actor_id: string or null`
20482063
20492064 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2071
20562071
20572072 Tagged service account ID (`svac_...`).
20582073
2059 - `type: "service_account_workspace_member"`
2060
2061 default: service_account_workspace_member
2062
20632074 - `workspace_id: string`
20642075
20652076 Tagged workspace ID (`wrkspc_...`).
from line 2148
21372148
21382149 - `string`
21392150
2140 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2151 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
21412152
21422153 - `"message-batches-2024-09-24"`
21432154
from line 2196
21852196
21862197 - `"user-profiles-2026-08-18"`
21872198
2199 - `"user-profiles-2026-09-04"`
2200
21882201 - `"advisor-tool-2026-03-01"`
21892202
21902203 - `"managed-agents-2026-04-01"`
from line 2244
22312244
22322245- `BetaServiceAccountWorkspaceMember object`
22332246
2247 - `type: "service_account_workspace_member"`
2248
2249 default: service_account_workspace_member
2250
22342251 - `created_by_actor_id: string or null`
22352252
22362253 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2260
22432260
22442261 Tagged service account ID (`svac_...`).
22452262
2246 - `type: "service_account_workspace_member"`
2247
2248 default: service_account_workspace_member
2249
22502263 - `workspace_id: string`
22512264
22522265 Tagged workspace ID (`wrkspc_...`).
from line 2332
23192332
23202333 - `string`
23212334
2322 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2335 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
23232336
23242337 - `"message-batches-2024-09-24"`
23252338
from line 2380
23672380
23682381 - `"user-profiles-2026-08-18"`
23692382
2383 - `"user-profiles-2026-09-04"`
2384
23702385 - `"advisor-tool-2026-03-01"`
23712386
23722387 - `"managed-agents-2026-04-01"`
from line 2442
24272442
24282443- `BetaServiceAccountWorkspaceMember object`
24292444
2445 - `type: "service_account_workspace_member"`
2446
2447 default: service_account_workspace_member
2448
24302449 - `created_by_actor_id: string or null`
24312450
24322451 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 2458
24392458
24402459 Tagged service account ID (`svac_...`).
24412460
2442 - `type: "service_account_workspace_member"`
2443
2444 default: service_account_workspace_member
2445
24462461 - `workspace_id: string`
24472462
24482463 Tagged workspace ID (`wrkspc_...`).
from line 2533
25182533
25192534 - `string`
25202535
2521 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2536 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
25222537
25232538 - `"message-batches-2024-09-24"`
25242539
from line 2581
25662581
25672582 - `"user-profiles-2026-08-18"`
25682583
2584 - `"user-profiles-2026-09-04"`
2585
25692586 - `"advisor-tool-2026-03-01"`
25702587
25712588 - `"managed-agents-2026-04-01"`
from line 2627
26102627
26112628#### Returns
26122629
2613- `service_account_id: string`
2614
2615 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
2616
26172630- `type: "service_account_workspace_member_deleted"`
26182631
26192632 default: service_account_workspace_member_deleted
2633
2634- `service_account_id: string`
2635
2636 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
26202637
26212638- `workspace_id: string`
26222639
api/beta/organization/workspaces/archive Changed · +13 / -8 lines
from line 1
1---
2title: Archive Workspace
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/archive
4---
5
16# Archive Workspace
27
38**POST** `/v1/organizations/workspaces/{workspace_id}/archive`
from line 17
1217
1318- `BetaWorkspace object`
1419
20 - `type: "workspace"`
21
22 Object type.
23
24 For Workspaces, this is always `"workspace"`.
25
26 default: workspace
27
1528 - `id: string`
1629
1730 ID of the Workspace.
from line 100
87100 - `tags: map[string]`
88101
89102 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
90
91 - `type: "workspace"`
92
93 Object type.
94
95 For Workspaces, this is always `"workspace"`.
96
97 default: workspace
98103
99104## Example
100105
api/beta/organization/workspaces/create Changed · +16 / -9 lines
from line 1
1---
2title: Create Workspace
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/create
4---
5
16# Create Workspace
27
38**POST** `/v1/organizations/workspaces`
from line 17
1217
1318 - `string`
1419
15 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1621
1722 - `"message-batches-2024-09-24"`
1823
from line 65
6065
6166 - `"user-profiles-2026-08-18"`
6267
68 - `"user-profiles-2026-09-04"`
69
6370 - `"advisor-tool-2026-03-01"`
6471
6572 - `"managed-agents-2026-04-01"`
from line 173
166173
167174- `BetaWorkspace object`
168175
176 - `type: "workspace"`
177
178 Object type.
179
180 For Workspaces, this is always `"workspace"`.
181
182 default: workspace
183
169184 - `id: string`
170185
171186 ID of the Workspace.
from line 256
241256 - `tags: map[string]`
242257
243258 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
244
245 - `type: "workspace"`
246
247 Object type.
248
249 For Workspaces, this is always `"workspace"`.
250
251 default: workspace
252259
253260## Example
254261
api/beta/organization/workspaces/list Changed · +13 / -8 lines
from line 1
1---
2title: List Workspaces
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/list
4---
5
16# List Workspaces
27
38**GET** `/v1/organizations/workspaces`
from line 37
3237
3338- `data: array of BetaWorkspace`
3439
40 - `type: "workspace"`
41
42 Object type.
43
44 For Workspaces, this is always `"workspace"`.
45
46 default: workspace
47
3548 - `id: string`
3649
3750 ID of the Workspace.
from line 120
107120 - `tags: map[string]`
108121
109122 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
110
111 - `type: "workspace"`
112
113 Object type.
114
115 For Workspaces, this is always `"workspace"`.
116
117 default: workspace
118123
119124- `first_id: string or null`
120125
api/beta/organization/workspaces/members Changed · +5 / -0 lines
from line 1
1---
2title: Members
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members
4---
5
16# Members
27
38## List Workspace Members
api/beta/organization/workspaces/members/add Changed · +5 / -0 lines
from line 1
1---
2title: Create Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/add
4---
5
16# Create Workspace Member
27
38**POST** `/v1/organizations/workspaces/{workspace_id}/members`
api/beta/organization/workspaces/members/list Changed · +5 / -0 lines
from line 1
1---
2title: List Workspace Members
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/list
4---
5
16# List Workspace Members
27
38**GET** `/v1/organizations/workspaces/{workspace_id}/members`
api/beta/organization/workspaces/members/remove Changed · +5 / -0 lines
from line 1
1---
2title: Delete Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/remove
4---
5
16# Delete Workspace Member
27
38**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
api/beta/organization/workspaces/members/retrieve Changed · +5 / -0 lines
from line 1
1---
2title: Get Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/retrieve
4---
5
16# Get Workspace Member
27
38**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
api/beta/organization/workspaces/members/update Changed · +5 / -0 lines
from line 1
1---
2title: Update Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/members/update
4---
5
16# Update Workspace Member
27
38**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`
api/beta/organization/workspaces/rate_limits Changed · +29 / -24 lines
from line 1
1---
2title: Rate Limits
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits
4---
5
16# Rate Limits
27
38## List Workspace Rate Limits
from line 61
5661
5762 Rate-limit entries for the workspace, one per group that has at least one override.
5863
64 - `type: "workspace_rate_limit"`
65
66 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
67
68 default: workspace_rate_limit
69
5970 - `group_type: "batch" or "files" or "model_group" or 3 more`
6071
6172 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`.
from line 87
7687
7788 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
7889
79 - `org_limit: number or null`
80
81 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
82
8390 - `type: string`
8491
8592 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
8693
94 - `org_limit: number or null`
95
96 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
97
8798 - `value: number`
8899
89100 The workspace-level override value for this limiter type.
from line 107
96107
97108 The `id` of the RateLimit group this override applies to.
98109
99 - `type: "workspace_rate_limit"`
100
101 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
102
103 default: workspace_rate_limit
104
105110 - `workspace_id: string`
106111
107112 ID of the Workspace this override applies to.
from line 155
150155
151156- `BetaWorkspaceRateLimit object`
152157
158 - `type: "workspace_rate_limit"`
159
160 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
161
162 default: workspace_rate_limit
163
153164 - `group_type: "batch" or "files" or "model_group" or 3 more`
154165
155166 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`.
from line 181
170181
171182 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
172183
173 - `org_limit: number or null`
174
175 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
176
177184 - `type: string`
178185
179186 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
180187
188 - `org_limit: number or null`
189
190 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
191
181192 - `value: number`
182193
183194 The workspace-level override value for this limiter type.
from line 201
190201
191202 The `id` of the RateLimit group this override applies to.
192203
193 - `type: "workspace_rate_limit"`
194
195 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
196
197 default: workspace_rate_limit
198
199204 - `workspace_id: string`
200205
201206 ID of the Workspace this override applies to.
from line 209
204209
205210- `BetaWorkspaceRateLimitValue object`
206211
207 - `org_limit: number or null`
208
209 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
210
211212 - `type: string`
212213
213214 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
215
216 - `org_limit: number or null`
217
218 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
214219
215220 - `value: number`
216221
api/beta/organization/workspaces/rate_limits/list Changed · +15 / -10 lines
from line 1
1---
2title: List Workspace Rate Limits
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/rate_limits/list
4---
5
16# List Workspace Rate Limits
27
38**GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits`
from line 59
5459
5560 Rate-limit entries for the workspace, one per group that has at least one override.
5661
62 - `type: "workspace_rate_limit"`
63
64 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
65
66 default: workspace_rate_limit
67
5768 - `group_type: "batch" or "files" or "model_group" or 3 more`
5869
5970 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`.
from line 85
7485
7586 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.
7687
77 - `org_limit: number or null`
78
79 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
80
8188 - `type: string`
8289
8390 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).
8491
92 - `org_limit: number or null`
93
94 The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type.
95
8596 - `value: number`
8697
8798 The workspace-level override value for this limiter type.
from line 104
93104 - `rate_limit_id: string`
94105
95106 The `id` of the RateLimit group this override applies to.
96
97 - `type: "workspace_rate_limit"`
98
99 Object type. Always `workspace_rate_limit` for workspace rate-limit entries.
100
101 default: workspace_rate_limit
102107
103108 - `workspace_id: string`
104109
api/beta/organization/workspaces/retrieve Changed · +13 / -8 lines
from line 1
1---
2title: Get Workspace
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/retrieve
4---
5
16# Get Workspace
27
38**GET** `/v1/organizations/workspaces/{workspace_id}`
from line 19
1419
1520- `BetaWorkspace object`
1621
22 - `type: "workspace"`
23
24 Object type.
25
26 For Workspaces, this is always `"workspace"`.
27
28 default: workspace
29
1730 - `id: string`
1831
1932 ID of the Workspace.
from line 102
89102 - `tags: map[string]`
90103
91104 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
92
93 - `type: "workspace"`
94
95 Object type.
96
97 For Workspaces, this is always `"workspace"`.
98
99 default: workspace
100105
101106## Example
102107
api/beta/organization/workspaces/service_accounts Changed · +44 / -29 lines
from line 1
1---
2title: Service Accounts
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts
4---
5
16# Service Accounts
27
38## List Service Account Workspace Members
from line 46
4146
4247 - `string`
4348
44 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
49 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
4550
4651 - `"message-batches-2024-09-24"`
4752
from line 94
8994
9095 - `"user-profiles-2026-08-18"`
9196
97 - `"user-profiles-2026-09-04"`
98
9299 - `"advisor-tool-2026-03-01"`
93100
94101 - `"managed-agents-2026-04-01"`
from line 142
135142
136143- `data: array of BetaServiceAccountWorkspaceMember`
137144
145 - `type: "service_account_workspace_member"`
146
147 default: service_account_workspace_member
148
138149 - `created_by_actor_id: string or null`
139150
140151 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 158
147158
148159 Tagged service account ID (`svac_...`).
149160
150 - `type: "service_account_workspace_member"`
151
152 default: service_account_workspace_member
153
154161 - `workspace_id: string`
155162
156163 Tagged workspace ID (`wrkspc_...`).
from line 237
230237
231238 - `string`
232239
233 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
240 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
234241
235242 - `"message-batches-2024-09-24"`
236243
from line 285
278285
279286 - `"user-profiles-2026-08-18"`
280287
288 - `"user-profiles-2026-09-04"`
289
281290 - `"advisor-tool-2026-03-01"`
282291
283292 - `"managed-agents-2026-04-01"`
from line 351
342351
343352- `BetaServiceAccountWorkspaceMember object`
344353
354 - `type: "service_account_workspace_member"`
355
356 default: service_account_workspace_member
357
345358 - `created_by_actor_id: string or null`
346359
347360 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 367
354367
355368 Tagged service account ID (`svac_...`).
356369
357 - `type: "service_account_workspace_member"`
358
359 default: service_account_workspace_member
360
361370 - `workspace_id: string`
362371
363372 Tagged workspace ID (`wrkspc_...`).
from line 444
435444
436445 - `string`
437446
438 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
447 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
439448
440449 - `"message-batches-2024-09-24"`
441450
from line 492
483492
484493 - `"user-profiles-2026-08-18"`
485494
495 - `"user-profiles-2026-09-04"`
496
486497 - `"advisor-tool-2026-03-01"`
487498
488499 - `"managed-agents-2026-04-01"`
from line 540
529540
530541- `BetaServiceAccountWorkspaceMember object`
531542
543 - `type: "service_account_workspace_member"`
544
545 default: service_account_workspace_member
546
532547 - `created_by_actor_id: string or null`
533548
534549 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 556
541556
542557 Tagged service account ID (`svac_...`).
543558
544 - `type: "service_account_workspace_member"`
545
546 default: service_account_workspace_member
547
548559 - `workspace_id: string`
549560
550561 Tagged workspace ID (`wrkspc_...`).
from line 628
617628
618629 - `string`
619630
620 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
631 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
621632
622633 - `"message-batches-2024-09-24"`
623634
from line 676
665676
666677 - `"user-profiles-2026-08-18"`
667678
679 - `"user-profiles-2026-09-04"`
680
668681 - `"advisor-tool-2026-03-01"`
669682
670683 - `"managed-agents-2026-04-01"`
from line 738
725738
726739- `BetaServiceAccountWorkspaceMember object`
727740
741 - `type: "service_account_workspace_member"`
742
743 default: service_account_workspace_member
744
728745 - `created_by_actor_id: string or null`
729746
730747 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 754
737754
738755 Tagged service account ID (`svac_...`).
739756
740 - `type: "service_account_workspace_member"`
741
742 default: service_account_workspace_member
743
744757 - `workspace_id: string`
745758
746759 Tagged workspace ID (`wrkspc_...`).
from line 829
816829
817830 - `string`
818831
819 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
832 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
820833
821834 - `"message-batches-2024-09-24"`
822835
from line 877
864877
865878 - `"user-profiles-2026-08-18"`
866879
880 - `"user-profiles-2026-09-04"`
881
867882 - `"advisor-tool-2026-03-01"`
868883
869884 - `"managed-agents-2026-04-01"`
from line 923
908923
909924### Returns
910925
911- `service_account_id: string`
912
913 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
914
915926- `type: "service_account_workspace_member_deleted"`
916927
917928 default: service_account_workspace_member_deleted
918929
930- `service_account_id: string`
931
932 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
933
919934- `workspace_id: string`
920935
921936 Tagged workspace ID (`wrkspc_...`) named in the delete request.
from line 960
945960
946961- `ServiceAccountRemoveResponse object`
947962
948 - `service_account_id: string`
949
950 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
951
952963 - `type: "service_account_workspace_member_deleted"`
953964
954965 default: service_account_workspace_member_deleted
966
967 - `service_account_id: string`
968
969 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
955970
956971 - `workspace_id: string`
957972
api/beta/organization/workspaces/service_accounts/add Changed · +12 / -5 lines
from line 1
1---
2title: Create Service Account Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/add
4---
5
16# Create Service Account Workspace Member
27
38**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
from line 34
2934
3035 - `string`
3136
32 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
37 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3338
3439 - `"message-batches-2024-09-24"`
3540
from line 82
7782
7883 - `"user-profiles-2026-08-18"`
7984
85 - `"user-profiles-2026-09-04"`
86
8087 - `"advisor-tool-2026-03-01"`
8188
8289 - `"managed-agents-2026-04-01"`
from line 148
141148
142149- `BetaServiceAccountWorkspaceMember object`
143150
151 - `type: "service_account_workspace_member"`
152
153 default: service_account_workspace_member
154
144155 - `created_by_actor_id: string or null`
145156
146157 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 163
152163 - `service_account_id: string`
153164
154165 Tagged service account ID (`svac_...`).
155
156 - `type: "service_account_workspace_member"`
157
158 default: service_account_workspace_member
159166
160167 - `workspace_id: string`
161168
api/beta/organization/workspaces/service_accounts/list Changed · +12 / -5 lines
from line 1
1---
2title: List Service Account Workspace Members
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/list
4---
5
16# List Service Account Workspace Members
27
38**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
from line 44
3944
4045 - `string`
4146
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
47 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
4348
4449 - `"message-batches-2024-09-24"`
4550
from line 92
8792
8893 - `"user-profiles-2026-08-18"`
8994
95 - `"user-profiles-2026-09-04"`
96
9097 - `"advisor-tool-2026-03-01"`
9198
9299 - `"managed-agents-2026-04-01"`
from line 140
133140
134141- `data: array of BetaServiceAccountWorkspaceMember`
135142
143 - `type: "service_account_workspace_member"`
144
145 default: service_account_workspace_member
146
136147 - `created_by_actor_id: string or null`
137148
138149 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 155
144155 - `service_account_id: string`
145156
146157 Tagged service account ID (`svac_...`).
147
148 - `type: "service_account_workspace_member"`
149
150 default: service_account_workspace_member
151158
152159 - `workspace_id: string`
153160
api/beta/organization/workspaces/service_accounts/remove Changed · +12 / -5 lines
from line 1
1---
2title: Delete Service Account Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/remove
4---
5
16# Delete Service Account Workspace Member
27
38**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
from line 35
3035
3136 - `string`
3237
33 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
38 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3439
3540 - `"message-batches-2024-09-24"`
3641
from line 83
7883
7984 - `"user-profiles-2026-08-18"`
8085
86 - `"user-profiles-2026-09-04"`
87
8188 - `"advisor-tool-2026-03-01"`
8289
8390 - `"managed-agents-2026-04-01"`
from line 129
122129
123130## Returns
124131
125- `service_account_id: string`
126
127 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
128
129132- `type: "service_account_workspace_member_deleted"`
130133
131134 default: service_account_workspace_member_deleted
135
136- `service_account_id: string`
137
138 Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op.
132139
133140- `workspace_id: string`
134141
api/beta/organization/workspaces/service_accounts/retrieve Changed · +12 / -5 lines
from line 1
1---
2title: Get Service Account Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/retrieve
4---
5
16# Get Service Account Workspace Member
27
38**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
from line 36
3136
3237 - `string`
3338
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
39 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3540
3641 - `"message-batches-2024-09-24"`
3742
from line 84
7984
8085 - `"user-profiles-2026-08-18"`
8186
87 - `"user-profiles-2026-09-04"`
88
8289 - `"advisor-tool-2026-03-01"`
8390
8491 - `"managed-agents-2026-04-01"`
from line 132
125132
126133- `BetaServiceAccountWorkspaceMember object`
127134
135 - `type: "service_account_workspace_member"`
136
137 default: service_account_workspace_member
138
128139 - `created_by_actor_id: string or null`
129140
130141 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 147
136147 - `service_account_id: string`
137148
138149 Tagged service account ID (`svac_...`).
139
140 - `type: "service_account_workspace_member"`
141
142 default: service_account_workspace_member
143150
144151 - `workspace_id: string`
145152
api/beta/organization/workspaces/service_accounts/update Changed · +12 / -5 lines
from line 1
1---
2title: Update Service Account Workspace Member
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/service_accounts/update
4---
5
16# Update Service Account Workspace Member
27
38**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
from line 36
3136
3237 - `string`
3338
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
39 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3540
3641 - `"message-batches-2024-09-24"`
3742
from line 84
7984
8085 - `"user-profiles-2026-08-18"`
8186
87 - `"user-profiles-2026-09-04"`
88
8289 - `"advisor-tool-2026-03-01"`
8390
8491 - `"managed-agents-2026-04-01"`
from line 146
139146
140147- `BetaServiceAccountWorkspaceMember object`
141148
149 - `type: "service_account_workspace_member"`
150
151 default: service_account_workspace_member
152
142153 - `created_by_actor_id: string or null`
143154
144155 Tagged ID (`user_...`/`svac_...`) of the actor who created this membership.
from line 161
150161 - `service_account_id: string`
151162
152163 Tagged service account ID (`svac_...`).
153
154 - `type: "service_account_workspace_member"`
155
156 default: service_account_workspace_member
157164
158165 - `workspace_id: string`
159166
api/beta/organization/workspaces/update Changed · +13 / -8 lines
from line 1
1---
2title: Update Workspace
3url: https://platform.claude.com/docs/en/api/beta/organization/workspaces/update
4---
5
16# Update Workspace
27
38**POST** `/v1/organizations/workspaces/{workspace_id}`
from line 73
6873
6974- `BetaWorkspace object`
7075
76 - `type: "workspace"`
77
78 Object type.
79
80 For Workspaces, this is always `"workspace"`.
81
82 default: workspace
83
7184 - `id: string`
7285
7386 ID of the Workspace.
from line 156
143156 - `tags: map[string]`
144157
145158 User-defined tags as string key-value pairs. Keys may not begin with `anthropic`.
146
147 - `type: "workspace"`
148
149 Object type.
150
151 For Workspaces, this is always `"workspace"`.
152
153 default: workspace
154159
155160## Example
156161
api/beta/sessions Changed · +18671 / -17430 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
Nothing in the body moved in this read. What changed is above.
api/beta/sessions/archive Changed · +386 / -331 lines
from line 1
1---
2title: Archive Session
3url: https://platform.claude.com/docs/en/api/beta/sessions/archive
4---
5
16# Archive Session
27
38**POST** `/v1/sessions/{session_id}/archive`
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 113
106113
107114 - `"mid-conversation-system-clear-at-2026-08-21"`
108115
116- `"anthropic-workspace-id": optional string`
117
109118## Returns
110119
111120- `BetaManagedAgentsSession object`
from line 121
112121
113122 A Managed Agents `session`.
114123
124 - `type: "session"`
125
115126 - `id: string`
116127
117128 - `agent: BetaManagedAgentsSessionAgent`
from line 129
118129
119130 Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time.
120131
132 - `type: "agent"`
133
121134 - `id: string`
122135
123136 - `description: string or null`
from line 137
124137
125138 - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
126139
127 - `name: string`
128
129140 - `type: "url"`
130141
142 - `name: string`
143
131144 - `url: string`
132145
133146 - `model: BetaManagedAgentsModelConfig`
from line 267
254267
255268 Resolved coordinator topology with full agent definitions for each roster member.
256269
270 - `type: "coordinator"`
271
257272 - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
258273
259274 Full `agent` definitions the coordinator may spawn as session threads.
from line 277
262277
263278 Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`.
264279
280 - `type: "agent"`
281
265282 - `id: string`
266283
267284 - `description: string or null`
from line 285
268285
269286 - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
270287
271 - `name: string`
272
273288 - `type: "url"`
274289
290 - `name: string`
291
275292 - `url: string`
276293
277294 - `model: BetaManagedAgentsModelConfig`
from line 303
286303
287304 A resolved Anthropic-managed skill.
288305
289 - `skill_id: string`
290
291306 - `type: "anthropic"`
292307
308 - `skill_id: string`
309
293310 - `version: string`
294311
295312 - `BetaManagedAgentsCustomSkill object`
from line 313
296313
297314 A resolved user-created custom skill.
298315
299 - `skill_id: string`
300
301316 - `type: "custom"`
302317
318 - `skill_id: string`
319
303320 - `version: string`
304321
305322 - `system: string or null`
from line 325
308325
309326 - `BetaManagedAgentsAgentToolset20260401 object`
310327
328 - `type: "agent_toolset_20260401"`
329
311330 - `configs: array of BetaManagedAgentsAgentToolConfig`
312331
313332 - `BetaManagedAgentsBashToolConfig object`
from line 333
314333
315334 Configuration for the bash tool.
316335
336 - `type: "bash"`
337
317338 - `enabled: boolean`
318339
319340 - `name: "bash"`
320341
321 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
342 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
322343
323344 Permission policy for tool execution.
324345
from line 355
334355
335356 - `type: "always_ask"`
336357
337 - `type: "bash"`
358 - `BetaManagedAgentsAutoPolicy object`
338359
360 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
361
362 - `type: "auto"`
363
339364 - `BetaManagedAgentsEditToolConfig object`
340365
341366 Configuration for the edit tool.
342367
368 - `type: "edit"`
369
343370 - `enabled: boolean`
344371
345372 - `name: "edit"`
346373
347 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
374 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
348375
349376 Permission policy for tool execution.
350377
from line 383
356383
357384 Tool calls require user confirmation before execution.
358385
359 - `type: "edit"`
386 - `BetaManagedAgentsAutoPolicy object`
360387
388 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
389
361390 - `BetaManagedAgentsReadToolConfig object`
362391
363392 Configuration for the read tool.
364393
394 - `type: "read"`
395
365396 - `enabled: boolean`
366397
367398 - `name: "read"`
368399
369 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
400 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
370401
371402 Permission policy for tool execution.
372403
from line 409
378409
379410 Tool calls require user confirmation before execution.
380411
381 - `type: "read"`
412 - `BetaManagedAgentsAutoPolicy object`
382413
414 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
415
383416 - `BetaManagedAgentsWriteToolConfig object`
384417
385418 Configuration for the write tool.
386419
420 - `type: "write"`
421
387422 - `enabled: boolean`
388423
389424 - `name: "write"`
390425
391 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
426 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
392427
393428 Permission policy for tool execution.
394429
from line 435
400435
401436 Tool calls require user confirmation before execution.
402437
403 - `type: "write"`
438 - `BetaManagedAgentsAutoPolicy object`
404439
440 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
441
405442 - `BetaManagedAgentsGlobToolConfig object`
406443
407444 Configuration for the glob tool.
408445
446 - `type: "glob"`
447
409448 - `enabled: boolean`
410449
411450 - `name: "glob"`
412451
413 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
452 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
414453
415454 Permission policy for tool execution.
416455
from line 461
422461
423462 Tool calls require user confirmation before execution.
424463
425 - `type: "glob"`
464 - `BetaManagedAgentsAutoPolicy object`
426465
466 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
467
427468 - `BetaManagedAgentsGrepToolConfig object`
428469
429470 Configuration for the grep tool.
430471
472 - `type: "grep"`
473
431474 - `enabled: boolean`
432475
433476 - `name: "grep"`
434477
435 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
478 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
436479
437480 Permission policy for tool execution.
438481
from line 487
444487
445488 Tool calls require user confirmation before execution.
446489
447 - `type: "grep"`
490 - `BetaManagedAgentsAutoPolicy object`
448491
492 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
493
449494 - `BetaManagedAgentsWebFetchToolConfig object`
450495
451496 Configuration for the web_fetch tool.
452497
498 - `type: "web_fetch"`
499
453500 - `enabled: boolean`
454501
455502 - `name: "web_fetch"`
456503
457 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
504 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
458505
459506 Permission policy for tool execution.
460507
from line 513
466513
467514 Tool calls require user confirmation before execution.
468515
469 - `type: "web_fetch"`
516 - `BetaManagedAgentsAutoPolicy object`
470517
518 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
519
471520 - `allowed_domains: optional array of string`
472521
473522 - `blocked_domains: optional array of string`
from line 529
480529
481530 Configuration for the web_search tool.
482531
532 - `type: "web_search"`
533
483534 - `enabled: boolean`
484535
485536 - `name: "web_search"`
486537
487 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
538 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
488539
489540 Permission policy for tool execution.
490541
from line 547
496547
497548 Tool calls require user confirmation before execution.
498549
499 - `type: "web_search"`
550 - `BetaManagedAgentsAutoPolicy object`
500551
552 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
553
501554 - `allowed_domains: optional array of string`
502555
503556 - `blocked_domains: optional array of string`
from line 591
538591
539592 - `enabled: boolean`
540593
541 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
594 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
542595
543596 Permission policy for tool execution.
544597
from line 603
550603
551604 Tool calls require user confirmation before execution.
552605
553 - `type: "agent_toolset_20260401"`
606 - `BetaManagedAgentsAutoPolicy object`
554607
608 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
609
555610 - `BetaManagedAgentsMCPToolset object`
556611
612 - `type: "mcp_toolset"`
613
557614 - `configs: array of BetaManagedAgentsMCPToolConfig`
558615
559616 - `enabled: boolean`
from line 617
560617
561618 - `name: string`
562619
563 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
620 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
564621
565622 Permission policy for tool execution.
566623
from line 629
572629
573630 Tool calls require user confirmation before execution.
574631
632 - `BetaManagedAgentsAutoPolicy object`
633
634 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
635
575636 - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig`
576637
577638 Resolved default configuration for all tools from an MCP server.
from line 639
578639
579640 - `enabled: boolean`
580641
581 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
642 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy`
582643
583644 Permission policy for tool execution.
584645
from line 651
590651
591652 Tool calls require user confirmation before execution.
592653
593 - `mcp_server_name: string`
654 - `BetaManagedAgentsAutoPolicy object`
594655
595 - `type: "mcp_toolset"`
656 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
596657
658 - `mcp_server_name: string`
659
597660 - `BetaManagedAgentsCustomTool object`
598661
599662 A custom tool as returned in API responses.
600663
664 - `type: "custom"`
665
601666 - `description: string`
602667
603668 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
from line 677
612677
613678 - `name: string`
614679
615 - `type: "custom"`
616
617 - `type: "agent"`
618
619680 - `version: number`
620681
621682 format: int32
from line 685
624685
625686 Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
626687
688 - `type: "advisor"`
689
627690 - `model: string`
628691
629692 The advisor model id.
630693
631 - `type: "advisor"`
632
633 - `type: "coordinator"`
634
635694 - `name: string`
636695
637696 - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
from line 715
656715
657716 A custom tool as returned in API responses.
658717
659 - `type: "agent"`
660
661718 - `version: number`
662719
663720 format: int32
from line 729
672729
673730 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
674731
732 - `type: "limit"`
733
675734 - `max_list_cost: BetaMonetaryAmount`
676735
677736 A monetary amount in a specific currency.
from line 743
684743
685744 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.
686745
687 - `type: "limit"`
688
689746 - `created_at: string`
690747
691748 A timestamp in RFC 3339 format
from line 757
700757
701758 Per-outcome evaluation state. One entry per `define_outcome` event sent to the session.
702759
760 - `type: "outcome_evaluation"`
761
703762 - `completed_at: string or null`
704763
705764 A timestamp in RFC 3339 format
from line 787
728787
729788 Current evaluation state. `pending` before the agent begins work; `running` while producing or revising; `evaluating` while the grader scores; `satisfied`/`max_iterations_reached`/`failed`/`interrupted` are terminal.
730789
731 - `type: "outcome_evaluation"`
732
733790 - `resources: array of BetaManagedAgentsSessionResource`
734791
735792 - `BetaManagedAgentsGitHubRepositoryResource object`
736793
794 - `type: "github_repository"`
795
737796 - `id: string`
738797
739798 - `created_at: string`
from line 803
744803
745804 - `mount_path: string`
746805
747 - `type: "github_repository"`
748
749806 - `updated_at: string`
750807
751808 A timestamp in RFC 3339 format
from line 815
758815
759816 - `BetaManagedAgentsBranchCheckout object`
760817
818 - `type: "branch"`
819
761820 - `name: string`
762821
763822 Branch name to check out.
from line 823
764823
765824 minLength: 1, maxLength: 255
766825
767 - `type: "branch"`
768
769826 - `BetaManagedAgentsCommitCheckout object`
770827
828 - `type: "commit"`
829
771830 - `sha: string`
772831
773832 Full commit SHA to check out.
from line 833
774833
775834 minLength: 7, maxLength: 64
776835
777 - `type: "commit"`
778
779836 - `BetaManagedAgentsFileResource object`
780837
838 - `type: "file"`
839
781840 - `id: string`
782841
783842 - `created_at: string`
from line 849
790849
791850 - `mount_path: string`
792851
793 - `type: "file"`
794
795852 - `updated_at: string`
796853
797854 A timestamp in RFC 3339 format
from line 859
802859
803860 A memory store attached to an agent session.
804861
862 - `type: "memory_store"`
863
805864 - `memory_store_id: string`
806865
807866 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
808867
809 - `type: "memory_store"`
810
811868 - `access: optional "read_write" or "read_only" or null`
812869
813870 Access mode for an attached memory store.
from line 920
863920 - `"terminated"`
864921
865922 - `title: string or null`
866
867 - `type: "session"`
868923
869924 - `updated_at: string`
870925