What this read moved
401–425 of 519This capture is too large to show at once. Changes 401-425 of 519 are below, significant first; the rest are on the following screens.
api/beta/user_profiles/update Changed · +125 / -7 lines
from line 1
1---
2title: Update User Profile
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/update
4---
5
16# Update User Profile
27
38**POST** `/v1/user_profiles/{user_profile_id}`
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 125
118125
119126- `external_id: optional string or null`
120127
121 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.
128 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
122129
123130 minLength: 1, maxLength: 255
124131
132- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
133
134 Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only.
135
136 - `account_status: optional "active" or "suspended" or "blocked" or null`
137
138 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
139
140 - `"active"`
141
142 - `"suspended"`
143
144 - `"blocked"`
145
146 - `country: optional string or null`
147
148 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
149
150 - `email_hash: optional string or null`
151
152 A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
153
154 minLength: 1, maxLength: 255
155
156 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
157
158 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
159
160 - `"individual"`
161
162 - `"business"`
163
164 - `"non_profit"`
165
166 - `"government"`
167
168 - `name_hash: optional string or null`
169
170 A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
171
172 minLength: 1, maxLength: 255
173
174 - `onboarded_at: optional string`
175
176 A timestamp in RFC 3339 format
177
178 format: date-time
179
180 - `reference_id: optional string or null`
181
182 The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.
183
184 minLength: 1, maxLength: 255
185
125186- `external_user_onboarded_at: optional string`
126187
127188 A timestamp in RFC 3339 format
from line 203
142203
143204- `BetaUserProfile object`
144205
206 - `type: "user_profile"`
207
208 Object type. Always `user_profile`.
209
145210 - `id: string`
146211
147212 Unique identifier for this user profile, prefixed `uprof_`.
from line 235
170235
171236 - `"rejected"`
172237
173 - `type: "user_profile"`
174
175 Object type. Always `user_profile`.
176
177238 - `updated_at: string`
178239
179240 A timestamp in RFC 3339 format
from line 251
190251
191252 - `external_id: optional string or null`
192253
193 Platform's own identifier for this user. Not enforced unique.
254 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
194255
256 - `external_user_details: optional BetaUserProfileExternalUserDetails`
257
258 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
259
260 - `account_status: "active" or "suspended" or "blocked" or null`
261
262 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
263
264 - `"active"`
265
266 - `"suspended"`
267
268 - `"blocked"`
269
270 - `country: string or null`
271
272 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
273
274 - `email_hash: string or null`
275
276 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
277
278 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
279
280 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
281
282 - `"individual"`
283
284 - `"business"`
285
286 - `"non_profit"`
287
288 - `"government"`
289
290 - `name_hash: string or null`
291
292 The platform-computed hash of the entity's name. `null` until the platform supplies one.
293
294 - `onboarded_at: string or null`
295
296 A timestamp in RFC 3339 format
297
298 format: date-time
299
300 - `reference_id: string or null`
301
302 The platform's own reference for the entity. `null` until the platform supplies one.
303
195304 - `external_user_onboarded_at: optional string or null`
196305
197306 A timestamp in RFC 3339 format
from line 340
231340 "updated_at": "2026-03-15T10:00:00Z",
232341 "access_type": "application",
233342 "external_id": "user_12345",
343 "external_user_details": {
344 "account_status": "active",
345 "country": "country",
346 "email_hash": "email_hash",
347 "entity_type": "individual",
348 "name_hash": "name_hash",
349 "onboarded_at": "2019-12-27T18:11:19.117Z",
350 "reference_id": "reference_id"
351 },
234352 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
235353 "name": "Example User"
236354}
api/beta/vaults Changed · +156 / -99 lines
from line 1
1---
2title: Vaults
3url: https://platform.claude.com/docs/en/api/beta/vaults
4---
5
16# Vaults
27
38## Create Vault
from line 19
1419
1520 - `string`
1621
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1823
1924 - `"message-batches-2024-09-24"`
2025
from line 67
6267
6368 - `"user-profiles-2026-08-18"`
6469
70 - `"user-profiles-2026-09-04"`
71
6572 - `"advisor-tool-2026-03-01"`
6673
6774 - `"managed-agents-2026-04-01"`
from line 111
104111
105112 - `"mid-conversation-system-clear-at-2026-08-21"`
106113
114- `"anthropic-workspace-id": optional string`
115
107116### Body parameters
108117
109118- `display_name: string`
from line 131
122131
123132 A vault that stores credentials for use by agents during sessions.
124133
134 - `type: "vault"`
135
125136 - `id: string`
126137
127138 Unique identifier for the vault.
from line 157
146157
147158 Arbitrary key-value metadata attached to the vault.
148159
149 - `type: "vault"`
150
151160 - `updated_at: string`
152161
153162 A timestamp in RFC 3339 format
from line 225
216225
217226 - `string`
218227
219 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
228 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
220229
221230 - `"message-batches-2024-09-24"`
222231
from line 273
264273
265274 - `"user-profiles-2026-08-18"`
266275
276 - `"user-profiles-2026-09-04"`
277
267278 - `"advisor-tool-2026-03-01"`
268279
269280 - `"managed-agents-2026-04-01"`
from line 317
306317
307318 - `"mid-conversation-system-clear-at-2026-08-21"`
308319
320- `"anthropic-workspace-id": optional string`
321
309322### Returns
310323
311324- `data: optional array of BetaManagedAgentsVault`
from line 325
312325
313326 List of vaults.
314327
328 - `type: "vault"`
329
315330 - `id: string`
316331
317332 Unique identifier for the vault.
from line 351
336351
337352 Arbitrary key-value metadata attached to the vault.
338353
339 - `type: "vault"`
340
341354 - `updated_at: string`
342355
343356 A timestamp in RFC 3339 format
from line 409
396409
397410 - `string`
398411
399 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
412 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
400413
401414 - `"message-batches-2024-09-24"`
402415
from line 457
444457
445458 - `"user-profiles-2026-08-18"`
446459
460 - `"user-profiles-2026-09-04"`
461
447462 - `"advisor-tool-2026-03-01"`
448463
449464 - `"managed-agents-2026-04-01"`
from line 501
486501
487502 - `"mid-conversation-system-clear-at-2026-08-21"`
488503
504- `"anthropic-workspace-id": optional string`
505
489506### Returns
490507
491508- `BetaManagedAgentsVault object`
from line 509
492509
493510 A vault that stores credentials for use by agents during sessions.
494511
512 - `type: "vault"`
513
495514 - `id: string`
496515
497516 Unique identifier for the vault.
from line 535
516535
517536 Arbitrary key-value metadata attached to the vault.
518537
519 - `type: "vault"`
520
521538 - `updated_at: string`
522539
523540 A timestamp in RFC 3339 format
from line 584
567584
568585 - `string`
569586
570 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
587 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
571588
572589 - `"message-batches-2024-09-24"`
573590
from line 632
615632
616633 - `"user-profiles-2026-08-18"`
617634
635 - `"user-profiles-2026-09-04"`
636
618637 - `"advisor-tool-2026-03-01"`
619638
620639 - `"managed-agents-2026-04-01"`
from line 676
657676
658677 - `"mid-conversation-system-clear-at-2026-08-21"`
659678
679- `"anthropic-workspace-id": optional string`
680
660681### Body parameters
661682
662683- `display_name: optional string or null`
from line 696
675696
676697 A vault that stores credentials for use by agents during sessions.
677698
699 - `type: "vault"`
700
678701 - `id: string`
679702
680703 Unique identifier for the vault.
from line 722
699722
700723 Arbitrary key-value metadata attached to the vault.
701724
702 - `type: "vault"`
703
704725 - `updated_at: string`
705726
706727 A timestamp in RFC 3339 format
from line 778
757778
758779 - `string`
759780
760 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
781 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
761782
762783 - `"message-batches-2024-09-24"`
763784
from line 826
805826
806827 - `"user-profiles-2026-08-18"`
807828
829 - `"user-profiles-2026-09-04"`
830
808831 - `"advisor-tool-2026-03-01"`
809832
810833 - `"managed-agents-2026-04-01"`
from line 870
847870
848871 - `"mid-conversation-system-clear-at-2026-08-21"`
849872
873- `"anthropic-workspace-id": optional string`
874
850875### Returns
851876
852877- `BetaManagedAgentsDeletedVault object`
from line 878
853878
854879 Confirmation of a deleted vault.
855880
881 - `type: "vault_deleted"`
882
856883 - `id: string`
857884
858885 Unique identifier of the deleted vault.
859886
860 - `type: "vault_deleted"`
861
862887### Example
863888
864889```bash
from line 921
896921
897922 - `string`
898923
899 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
924 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
900925
901926 - `"message-batches-2024-09-24"`
902927
from line 969
944969
945970 - `"user-profiles-2026-08-18"`
946971
972 - `"user-profiles-2026-09-04"`
973
947974 - `"advisor-tool-2026-03-01"`
948975
949976 - `"managed-agents-2026-04-01"`
from line 1013
9861013
9871014 - `"mid-conversation-system-clear-at-2026-08-21"`
9881015
1016- `"anthropic-workspace-id": optional string`
1017
9891018### Returns
9901019
9911020- `BetaManagedAgentsVault object`
from line 1021
9921021
9931022 A vault that stores credentials for use by agents during sessions.
9941023
1024 - `type: "vault"`
1025
9951026 - `id: string`
9961027
9971028 Unique identifier for the vault.
from line 1047
10161047
10171048 Arbitrary key-value metadata attached to the vault.
10181049
1019 - `type: "vault"`
1020
10211050 - `updated_at: string`
10221051
10231052 A timestamp in RFC 3339 format
from line 1087
10581087
10591088 Confirmation of a deleted vault.
10601089
1090 - `type: "vault_deleted"`
1091
10611092 - `id: string`
10621093
10631094 Unique identifier of the deleted vault.
10641095
1065 - `type: "vault_deleted"`
1066
10671096### Beta Managed Agents Vault
10681097
10691098- `BetaManagedAgentsVault object`
from line 1099
10701099
10711100 A vault that stores credentials for use by agents during sessions.
10721101
1102 - `type: "vault"`
1103
10731104 - `id: string`
10741105
10751106 Unique identifier for the vault.
from line 1125
10941125
10951126 Arbitrary key-value metadata attached to the vault.
10961127
1097 - `type: "vault"`
1098
10991128 - `updated_at: string`
11001129
11011130 A timestamp in RFC 3339 format
from line 1151
11221151
11231152 - `string`
11241153
1125 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1154 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
11261155
11271156 - `"message-batches-2024-09-24"`
11281157
from line 1199
11701199
11711200 - `"user-profiles-2026-08-18"`
11721201
1202 - `"user-profiles-2026-09-04"`
1203
11731204 - `"advisor-tool-2026-03-01"`
11741205
11751206 - `"managed-agents-2026-04-01"`
from line 1243
12121243
12131244 - `"mid-conversation-system-clear-at-2026-08-21"`
12141245
1246- `"anthropic-workspace-id": optional string`
1247
12151248#### Body parameters
12161249
12171250- `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams`
from line 1255
12221255
12231256 Parameters for creating an MCP OAuth credential.
12241257
1258 - `type: "mcp_oauth"`
1259
12251260 - `access_token: string`
12261261
12271262 OAuth access token.
from line 1269
12341269
12351270 minLength: 1, maxLength: 2047
12361271
1237 - `type: "mcp_oauth"`
1238
12391272 - `expires_at: optional string or null`
12401273
12411274 A timestamp in RFC 3339 format
from line 1289
12561289
12571290 OAuth refresh token.
12581291
1259 minLength: 1, maxLength: 4096
1292 minLength: 1, maxLength: 8192
12601293
12611294 - `token_endpoint: string`
12621295
from line 1311
12781311
12791312 Token endpoint uses HTTP Basic authentication with client credentials.
12801313
1314 - `type: "client_secret_basic"`
1315
12811316 - `client_secret: string`
12821317
12831318 OAuth client secret.
from line 1319
12841319
12851320 minLength: 1, maxLength: 512
12861321
1287 - `type: "client_secret_basic"`
1288
12891322 - `BetaManagedAgentsTokenEndpointAuthPostParam object`
12901323
12911324 Token endpoint uses POST body authentication with client credentials.
12921325
1326 - `type: "client_secret_post"`
1327
12931328 - `client_secret: string`
12941329
12951330 OAuth client secret.
from line 1331
12961331
12971332 minLength: 1, maxLength: 512
12981333
1299 - `type: "client_secret_post"`
1300
13011334 - `resource: optional string or null`
13021335
13031336 OAuth resource indicator.
from line 1347
13141347
13151348 Parameters for creating a static bearer token credential.
13161349
1350 - `type: "static_bearer"`
1351
13171352 - `token: string`
13181353
13191354 Static bearer token value.
from line 1361
13261361
13271362 minLength: 1, maxLength: 2047
13281363
1329 - `type: "static_bearer"`
1330
13311364 - `BetaManagedAgentsEnvironmentVariableCreateParams object`
13321365
13331366 Parameters for creating an environment variable credential.
13341367
1368 - `type: "environment_variable"`
1369
13351370 - `networking: BetaManagedAgentsCredentialNetworkingParams`
13361371
13371372 Outbound hosts the secret value is substituted on.
from line 1381
13461381
13471382 Substitute the secret only on requests to the listed hosts.
13481383
1384 - `type: "limited"`
1385
13491386 - `allowed_hosts: array of string`
13501387
13511388 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
13521389
1353 - `type: "limited"`
1354
13551390 - `secret_name: string`
13561391
13571392 Name of the environment variable. Immutable after create.
from line 1399
13641399
13651400 minLength: 1, maxLength: 4096
13661401
1367 - `type: "environment_variable"`
1368
13691402 - `injection_location: optional BetaManagedAgentsInjectionLocationParams`
13701403
13711404 Where in the outbound request the secret value may be substituted.
from line 1427
13941427
13951428 A credential stored in a vault. Sensitive fields are never returned in responses.
13961429
1430 - `type: "vault_credential"`
1431
13971432 - `id: string`
13981433
13991434 Unique identifier for the credential.
from line 1447
14121447
14131448 OAuth credential details for an MCP server.
14141449
1450 - `type: "mcp_oauth"`
1451
14151452 - `mcp_server_url: string`
14161453
14171454 URL of the MCP server this credential authenticates against.
14181455
1419 - `type: "mcp_oauth"`
1420
14211456 - `expires_at: optional string or null`
14221457
14231458 A timestamp in RFC 3339 format
from line 1505
14701505
14711506 Static bearer token credential details for an MCP server.
14721507
1508 - `type: "static_bearer"`
1509
14731510 - `mcp_server_url: string`
14741511
14751512 URL of the MCP server this credential authenticates against.
14761513
1477 - `type: "static_bearer"`
1478
14791514 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
14801515
14811516 Environment variable credential details. The secret value is never returned.
14821517
1518 - `type: "environment_variable"`
1519
14831520 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
14841521
14851522 Where in the outbound request the secret value is substituted.
from line 1543
15061543
15071544 The secret is substituted only on requests to the listed hosts.
15081545
1546 - `type: "limited"`
1547
15091548 - `allowed_hosts: array of string`
15101549
15111550 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
15121551
1513 - `type: "limited"`
1514
15151552 - `secret_name: string`
15161553
15171554 Name of the environment variable.
15181555
1519 - `type: "environment_variable"`
1520
15211556 - `created_at: string`
15221557
15231558 A timestamp in RFC 3339 format
from line 1563
15281563
15291564 Arbitrary key-value metadata attached to the credential.
15301565
1531 - `type: "vault_credential"`
1532
15331566 - `updated_at: string`
15341567
15351568 A timestamp in RFC 3339 format
from line 1653
16201653
16211654 - `string`
16221655
1623 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1656 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
16241657
16251658 - `"message-batches-2024-09-24"`
16261659
from line 1701
16681701
16691702 - `"user-profiles-2026-08-18"`
16701703
1704 - `"user-profiles-2026-09-04"`
1705
16711706 - `"advisor-tool-2026-03-01"`
16721707
16731708 - `"managed-agents-2026-04-01"`
from line 1745
17101745
17111746 - `"mid-conversation-system-clear-at-2026-08-21"`
17121747
1748- `"anthropic-workspace-id": optional string`
1749
17131750#### Returns
17141751
17151752- `data: optional array of BetaManagedAgentsCredential`
from line 1753
17161753
17171754 List of credentials.
17181755
1756 - `type: "vault_credential"`
1757
17191758 - `id: string`
17201759
17211760 Unique identifier for the credential.
from line 1773
17341773
17351774 OAuth credential details for an MCP server.
17361775
1776 - `type: "mcp_oauth"`
1777
17371778 - `mcp_server_url: string`
17381779
17391780 URL of the MCP server this credential authenticates against.
17401781
1741 - `type: "mcp_oauth"`
1742
17431782 - `expires_at: optional string or null`
17441783
17451784 A timestamp in RFC 3339 format
from line 1831
17921831
17931832 Static bearer token credential details for an MCP server.
17941833
1834 - `type: "static_bearer"`
1835
17951836 - `mcp_server_url: string`
17961837
17971838 URL of the MCP server this credential authenticates against.
17981839
1799 - `type: "static_bearer"`
1800
18011840 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
18021841
18031842 Environment variable credential details. The secret value is never returned.
18041843
1844 - `type: "environment_variable"`
1845
18051846 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
18061847
18071848 Where in the outbound request the secret value is substituted.
from line 1869
18281869
18291870 The secret is substituted only on requests to the listed hosts.
18301871
1872 - `type: "limited"`
1873
18311874 - `allowed_hosts: array of string`
18321875
18331876 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
18341877
1835 - `type: "limited"`
1836
18371878 - `secret_name: string`
18381879
18391880 Name of the environment variable.
18401881
1841 - `type: "environment_variable"`
1842
18431882 - `created_at: string`
18441883
18451884 A timestamp in RFC 3339 format
from line 1889
18501889
18511890 Arbitrary key-value metadata attached to the credential.
18521891
1853 - `type: "vault_credential"`
1854
18551892 - `updated_at: string`
18561893
18571894 A timestamp in RFC 3339 format
from line 1962
19251962
19261963 - `string`
19271964
1928 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1965 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
19291966
19301967 - `"message-batches-2024-09-24"`
19311968
from line 2010
19732010
19742011 - `"user-profiles-2026-08-18"`
19752012
2013 - `"user-profiles-2026-09-04"`
2014
19762015 - `"advisor-tool-2026-03-01"`
19772016
19782017 - `"managed-agents-2026-04-01"`
from line 2054
20152054
20162055 - `"mid-conversation-system-clear-at-2026-08-21"`
20172056
2057- `"anthropic-workspace-id": optional string`
2058
20182059#### Returns
20192060
20202061- `BetaManagedAgentsCredential object`
from line 2062
20212062
20222063 A credential stored in a vault. Sensitive fields are never returned in responses.
20232064
2065 - `type: "vault_credential"`
2066
20242067 - `id: string`
20252068
20262069 Unique identifier for the credential.
from line 2082
20392082
20402083 OAuth credential details for an MCP server.
20412084
2085 - `type: "mcp_oauth"`
2086
20422087 - `mcp_server_url: string`
20432088
20442089 URL of the MCP server this credential authenticates against.
20452090
2046 - `type: "mcp_oauth"`
2047
20482091 - `expires_at: optional string or null`
20492092
20502093 A timestamp in RFC 3339 format
from line 2140
20972140
20982141 Static bearer token credential details for an MCP server.
20992142
2143 - `type: "static_bearer"`
2144
21002145 - `mcp_server_url: string`
21012146
21022147 URL of the MCP server this credential authenticates against.
21032148
2104 - `type: "static_bearer"`
2105
21062149 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
21072150
21082151 Environment variable credential details. The secret value is never returned.
21092152
2153 - `type: "environment_variable"`
2154
21102155 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
21112156
21122157 Where in the outbound request the secret value is substituted.
from line 2178
21332178
21342179 The secret is substituted only on requests to the listed hosts.
21352180
2181 - `type: "limited"`
2182
21362183 - `allowed_hosts: array of string`
21372184
21382185 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
21392186
2140 - `type: "limited"`
2141
21422187 - `secret_name: string`
21432188
21442189 Name of the environment variable.
21452190
2146 - `type: "environment_variable"`
2147
21482191 - `created_at: string`
21492192
21502193 A timestamp in RFC 3339 format
from line 2198
21552198
21562199 Arbitrary key-value metadata attached to the credential.
21572200
2158 - `type: "vault_credential"`
2159
21602201 - `updated_at: string`
21612202
21622203 A timestamp in RFC 3339 format
from line 2262
22212262
22222263 - `string`
22232264
2224 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2265 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
22252266
22262267 - `"message-batches-2024-09-24"`
22272268
from line 2310
22692310
22702311 - `"user-profiles-2026-08-18"`
22712312
2313 - `"user-profiles-2026-09-04"`
2314
22722315 - `"advisor-tool-2026-03-01"`
22732316
22742317 - `"managed-agents-2026-04-01"`
from line 2354
23112354
23122355 - `"mid-conversation-system-clear-at-2026-08-21"`
23132356
2357- `"anthropic-workspace-id": optional string`
2358
23142359#### Body parameters
23152360
23162361- `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams`
from line 2388
23432388
23442389 Updated OAuth refresh token.
23452390
2346 minLength: 1, maxLength: 4096
2391 minLength: 1, maxLength: 8192
23472392
23482393 - `scope: optional string or null`
23492394
from line 2468
24232468
24242469 Substitute the secret only on requests to the listed hosts.
24252470
2471 - `type: "limited"`
2472
24262473 - `allowed_hosts: array of string`
24272474
24282475 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
24292476
2430 - `type: "limited"`
2431
24322477 - `secret_value: optional string or null`
24332478
24342479 Updated secret value.
from line 2496
24512496
24522497 A credential stored in a vault. Sensitive fields are never returned in responses.
24532498
2499 - `type: "vault_credential"`
2500
24542501 - `id: string`
24552502
24562503 Unique identifier for the credential.
from line 2516
24692516
24702517 OAuth credential details for an MCP server.
24712518
2519 - `type: "mcp_oauth"`
2520
24722521 - `mcp_server_url: string`
24732522
24742523 URL of the MCP server this credential authenticates against.
24752524
2476 - `type: "mcp_oauth"`
2477
24782525 - `expires_at: optional string or null`
24792526
24802527 A timestamp in RFC 3339 format
from line 2574
25272574
25282575 Static bearer token credential details for an MCP server.
25292576
2577 - `type: "static_bearer"`
2578
25302579 - `mcp_server_url: string`
25312580
25322581 URL of the MCP server this credential authenticates against.
25332582
2534 - `type: "static_bearer"`
2535
25362583 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
25372584
25382585 Environment variable credential details. The secret value is never returned.
25392586
2587 - `type: "environment_variable"`
2588
25402589 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
25412590
25422591 Where in the outbound request the secret value is substituted.
from line 2612
25632612
25642613 The secret is substituted only on requests to the listed hosts.
25652614
2615 - `type: "limited"`
2616
25662617 - `allowed_hosts: array of string`
25672618
25682619 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
25692620
2570 - `type: "limited"`
2571
25722621 - `secret_name: string`
25732622
25742623 Name of the environment variable.
25752624
2576 - `type: "environment_variable"`
2577
25782625 - `created_at: string`
25792626
25802627 A timestamp in RFC 3339 format
from line 2632
25852632
25862633 Arbitrary key-value metadata attached to the credential.
25872634
2588 - `type: "vault_credential"`
2589
25902635 - `updated_at: string`
25912636
25922637 A timestamp in RFC 3339 format
from line 2703
26582703
26592704 - `string`
26602705
2661 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2706 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
26622707
26632708 - `"message-batches-2024-09-24"`
26642709
from line 2751
27062751
27072752 - `"user-profiles-2026-08-18"`
27082753
2754 - `"user-profiles-2026-09-04"`
2755
27092756 - `"advisor-tool-2026-03-01"`
27102757
27112758 - `"managed-agents-2026-04-01"`
from line 2795
27482795
27492796 - `"mid-conversation-system-clear-at-2026-08-21"`
27502797
2798- `"anthropic-workspace-id": optional string`
2799
27512800#### Returns
27522801
27532802- `BetaManagedAgentsDeletedCredential object`
from line 2803
27542803
27552804 Confirmation of a deleted credential.
27562805
2806 - `type: "vault_credential_deleted"`
2807
27572808 - `id: string`
27582809
27592810 Unique identifier of the deleted credential.
27602811
2761 - `type: "vault_credential_deleted"`
2762
27632812#### Example
27642813
27652814```bash
from line 2848
27992848
28002849 - `string`
28012850
2802 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2851 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
28032852
28042853 - `"message-batches-2024-09-24"`
28052854
from line 2896
28472896
28482897 - `"user-profiles-2026-08-18"`
28492898
2899 - `"user-profiles-2026-09-04"`
2900
28502901 - `"advisor-tool-2026-03-01"`
28512902
28522903 - `"managed-agents-2026-04-01"`
from line 2940
28892940
28902941 - `"mid-conversation-system-clear-at-2026-08-21"`
28912942
2943- `"anthropic-workspace-id": optional string`
2944
28922945#### Returns
28932946
28942947- `BetaManagedAgentsCredential object`
from line 2948
28952948
28962949 A credential stored in a vault. Sensitive fields are never returned in responses.
28972950
2951 - `type: "vault_credential"`
2952
28982953 - `id: string`
28992954
29002955 Unique identifier for the credential.
from line 2968
29132968
29142969 OAuth credential details for an MCP server.
29152970
2971 - `type: "mcp_oauth"`
2972
29162973 - `mcp_server_url: string`
29172974
29182975 URL of the MCP server this credential authenticates against.
29192976
2920 - `type: "mcp_oauth"`
2921
29222977 - `expires_at: optional string or null`
29232978
29242979 A timestamp in RFC 3339 format
from line 3026
29713026
29723027 Static bearer token credential details for an MCP server.
29733028
3029 - `type: "static_bearer"`
3030
29743031 - `mcp_server_url: string`
29753032
29763033 URL of the MCP server this credential authenticates against.
29773034
2978 - `type: "static_bearer"`
2979
29803035 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
29813036
29823037 Environment variable credential details. The secret value is never returned.
29833038
3039 - `type: "environment_variable"`
3040
29843041 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
29853042
29863043 Where in the outbound request the secret value is substituted.
from line 3064
30073064
30083065 The secret is substituted only on requests to the listed hosts.
30093066
3067 - `type: "limited"`
3068
30103069 - `allowed_hosts: array of string`
30113070
30123071 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
30133072
3014 - `type: "limited"`
3015
30163073 - `secret_name: string`
30173074
30183075 Name of the environment variable.
30193076
3020 - `type: "environment_variable"`
3021
30223077 - `created_at: string`
30233078
30243079 A timestamp in RFC 3339 format
from line 3084
30293084
30303085 Arbitrary key-value metadata attached to the credential.
30313086
3032 - `type: "vault_credential"`
3033
30343087 - `updated_at: string`
30353088
30363089 A timestamp in RFC 3339 format
from line 3149
30963149
30973150 - `string`
30983151
3099 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
3152 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
31003153
31013154 - `"message-batches-2024-09-24"`
31023155
from line 3197
31443197
31453198 - `"user-profiles-2026-08-18"`
31463199
3200 - `"user-profiles-2026-09-04"`
3201
31473202 - `"advisor-tool-2026-03-01"`
31483203
31493204 - `"managed-agents-2026-04-01"`
from line 3241
31863241
31873242 - `"mid-conversation-system-clear-at-2026-08-21"`
31883243
3244- `"anthropic-workspace-id": optional string`
3245
31893246#### Returns
31903247
31913248- `BetaManagedAgentsCredentialValidation object`
from line 3249
31923249
31933250 Result of live-probing a credential against its configured MCP server.
31943251
3252 - `type: "vault_credential_validation"`
3253
31953254 - `credential_id: string`
31963255
31973256 Unique identifier of the credential that was validated.
from line 3318
32593318 - `"invalid"`
32603319
32613320 - `"unknown"`
3262
3263 - `type: "vault_credential_validation"`
32643321
32653322 - `validated_at: string`
32663323
api/beta/vaults/archive Changed · +12 / -3 lines
from line 1
1---
2title: Archive Vault
3url: https://platform.claude.com/docs/en/api/beta/vaults/archive
4---
5
16# Archive Vault
27
38**POST** `/v1/vaults/{vault_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- `BetaManagedAgentsVault object`
from line 121
112121
113122 A vault that stores credentials for use by agents during sessions.
114123
124 - `type: "vault"`
125
115126 - `id: string`
116127
117128 Unique identifier for the vault.
from line 146
135146 - `metadata: map[string]`
136147
137148 Arbitrary key-value metadata attached to the vault.
138
139 - `type: "vault"`
140149
141150 - `updated_at: string`
142151
api/beta/vaults/create Changed · +12 / -3 lines
from line 1
1---
2title: Create Vault
3url: https://platform.claude.com/docs/en/api/beta/vaults/create
4---
5
16# Create Vault
27
38**POST** `/v1/vaults`
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 109
102109
103110 - `"mid-conversation-system-clear-at-2026-08-21"`
104111
112- `"anthropic-workspace-id": optional string`
113
105114## Body parameters
106115
107116- `display_name: string`
from line 129
120129
121130 A vault that stores credentials for use by agents during sessions.
122131
132 - `type: "vault"`
133
123134 - `id: string`
124135
125136 Unique identifier for the vault.
from line 154
143154 - `metadata: map[string]`
144155
145156 Arbitrary key-value metadata attached to the vault.
146
147 - `type: "vault"`
148157
149158 - `updated_at: string`
150159
api/beta/vaults/credentials Changed · +696 / -663 lines
from line 1
1---
2title: Credentials
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials
4---
5
16# Credentials
27
38## Create Credential
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120### Body parameters
112121
113122- `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams`
from line 127
118127
119128 Parameters for creating an MCP OAuth credential.
120129
130 - `type: "mcp_oauth"`
131
121132 - `access_token: string`
122133
123134 OAuth access token.
from line 141
130141
131142 minLength: 1, maxLength: 2047
132143
133 - `type: "mcp_oauth"`
134
135144 - `expires_at: optional string or null`
136145
137146 A timestamp in RFC 3339 format
from line 161
152161
153162 OAuth refresh token.
154163
155 minLength: 1, maxLength: 4096
164 minLength: 1, maxLength: 8192
156165
157166 - `token_endpoint: string`
158167
from line 183
174183
175184 Token endpoint uses HTTP Basic authentication with client credentials.
176185
186 - `type: "client_secret_basic"`
187
177188 - `client_secret: string`
178189
179190 OAuth client secret.
from line 191
180191
181192 minLength: 1, maxLength: 512
182193
183 - `type: "client_secret_basic"`
184
185194 - `BetaManagedAgentsTokenEndpointAuthPostParam object`
186195
187196 Token endpoint uses POST body authentication with client credentials.
188197
198 - `type: "client_secret_post"`
199
189200 - `client_secret: string`
190201
191202 OAuth client secret.
from line 203
192203
193204 minLength: 1, maxLength: 512
194205
195 - `type: "client_secret_post"`
196
197206 - `resource: optional string or null`
198207
199208 OAuth resource indicator.
from line 219
210219
211220 Parameters for creating a static bearer token credential.
212221
222 - `type: "static_bearer"`
223
213224 - `token: string`
214225
215226 Static bearer token value.
from line 233
222233
223234 minLength: 1, maxLength: 2047
224235
225 - `type: "static_bearer"`
226
227236 - `BetaManagedAgentsEnvironmentVariableCreateParams object`
228237
229238 Parameters for creating an environment variable credential.
230239
240 - `type: "environment_variable"`
241
231242 - `networking: BetaManagedAgentsCredentialNetworkingParams`
232243
233244 Outbound hosts the secret value is substituted on.
from line 253
242253
243254 Substitute the secret only on requests to the listed hosts.
244255
256 - `type: "limited"`
257
245258 - `allowed_hosts: array of string`
246259
247260 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
248261
249 - `type: "limited"`
250
251262 - `secret_name: string`
252263
253264 Name of the environment variable. Immutable after create.
from line 271
260271
261272 minLength: 1, maxLength: 4096
262273
263 - `type: "environment_variable"`
264
265274 - `injection_location: optional BetaManagedAgentsInjectionLocationParams`
266275
267276 Where in the outbound request the secret value may be substituted.
from line 299
290299
291300 A credential stored in a vault. Sensitive fields are never returned in responses.
292301
302 - `type: "vault_credential"`
303
293304 - `id: string`
294305
295306 Unique identifier for the credential.
from line 319
308319
309320 OAuth credential details for an MCP server.
310321
322 - `type: "mcp_oauth"`
323
311324 - `mcp_server_url: string`
312325
313326 URL of the MCP server this credential authenticates against.
314327
315 - `type: "mcp_oauth"`
316
317328 - `expires_at: optional string or null`
318329
319330 A timestamp in RFC 3339 format
from line 377
366377
367378 Static bearer token credential details for an MCP server.
368379
380 - `type: "static_bearer"`
381
369382 - `mcp_server_url: string`
370383
371384 URL of the MCP server this credential authenticates against.
372385
373 - `type: "static_bearer"`
374
375386 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
376387
377388 Environment variable credential details. The secret value is never returned.
378389
390 - `type: "environment_variable"`
391
379392 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
380393
381394 Where in the outbound request the secret value is substituted.
from line 415
402415
403416 The secret is substituted only on requests to the listed hosts.
404417
418 - `type: "limited"`
419
405420 - `allowed_hosts: array of string`
406421
407422 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
408423
409 - `type: "limited"`
410
411424 - `secret_name: string`
412425
413426 Name of the environment variable.
414427
415 - `type: "environment_variable"`
416
417428 - `created_at: string`
418429
419430 A timestamp in RFC 3339 format
from line 435
424435
425436 Arbitrary key-value metadata attached to the credential.
426437
427 - `type: "vault_credential"`
428
429438 - `updated_at: string`
430439
431440 A timestamp in RFC 3339 format
from line 525
516525
517526 - `string`
518527
519 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
528 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
520529
521530 - `"message-batches-2024-09-24"`
522531
from line 573
564573
565574 - `"user-profiles-2026-08-18"`
566575
576 - `"user-profiles-2026-09-04"`
577
567578 - `"advisor-tool-2026-03-01"`
568579
569580 - `"managed-agents-2026-04-01"`
from line 617
606617
607618 - `"mid-conversation-system-clear-at-2026-08-21"`
608619
620- `"anthropic-workspace-id": optional string`
621
609622### Returns
610623
611624- `data: optional array of BetaManagedAgentsCredential`
from line 625
612625
613626 List of credentials.
614627
628 - `type: "vault_credential"`
629
615630 - `id: string`
616631
617632 Unique identifier for the credential.
from line 645
630645
631646 OAuth credential details for an MCP server.
632647
648 - `type: "mcp_oauth"`
649
633650 - `mcp_server_url: string`
634651
635652 URL of the MCP server this credential authenticates against.
636653
637 - `type: "mcp_oauth"`
638
639654 - `expires_at: optional string or null`
640655
641656 A timestamp in RFC 3339 format
from line 703
688703
689704 Static bearer token credential details for an MCP server.
690705
706 - `type: "static_bearer"`
707
691708 - `mcp_server_url: string`
692709
693710 URL of the MCP server this credential authenticates against.
694711
695 - `type: "static_bearer"`
696
697712 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
698713
699714 Environment variable credential details. The secret value is never returned.
700715
716 - `type: "environment_variable"`
717
701718 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
702719
703720 Where in the outbound request the secret value is substituted.
from line 741
724741
725742 The secret is substituted only on requests to the listed hosts.
726743
744 - `type: "limited"`
745
727746 - `allowed_hosts: array of string`
728747
729748 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
730749
731 - `type: "limited"`
732
733750 - `secret_name: string`
734751
735752 Name of the environment variable.
736753
737 - `type: "environment_variable"`
738
739754 - `created_at: string`
740755
741756 A timestamp in RFC 3339 format
from line 761
746761
747762 Arbitrary key-value metadata attached to the credential.
748763
749 - `type: "vault_credential"`
750
751764 - `updated_at: string`
752765
753766 A timestamp in RFC 3339 format
from line 834
821834
822835 - `string`
823836
824 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
837 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
825838
826839 - `"message-batches-2024-09-24"`
827840
from line 882
869882
870883 - `"user-profiles-2026-08-18"`
871884
885 - `"user-profiles-2026-09-04"`
886
872887 - `"advisor-tool-2026-03-01"`
873888
874889 - `"managed-agents-2026-04-01"`
from line 926
911926
912927 - `"mid-conversation-system-clear-at-2026-08-21"`
913928
929- `"anthropic-workspace-id": optional string`
930
914931### Returns
915932
916933- `BetaManagedAgentsCredential object`
from line 934
917934
918935 A credential stored in a vault. Sensitive fields are never returned in responses.
919936
937 - `type: "vault_credential"`
938
920939 - `id: string`
921940
922941 Unique identifier for the credential.
from line 954
935954
936955 OAuth credential details for an MCP server.
937956
957 - `type: "mcp_oauth"`
958
938959 - `mcp_server_url: string`
939960
940961 URL of the MCP server this credential authenticates against.
941962
942 - `type: "mcp_oauth"`
943
944963 - `expires_at: optional string or null`
945964
946965 A timestamp in RFC 3339 format
from line 1012
9931012
9941013 Static bearer token credential details for an MCP server.
9951014
1015 - `type: "static_bearer"`
1016
9961017 - `mcp_server_url: string`
9971018
9981019 URL of the MCP server this credential authenticates against.
9991020
1000 - `type: "static_bearer"`
1001
10021021 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
10031022
10041023 Environment variable credential details. The secret value is never returned.
10051024
1025 - `type: "environment_variable"`
1026
10061027 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
10071028
10081029 Where in the outbound request the secret value is substituted.
from line 1050
10291050
10301051 The secret is substituted only on requests to the listed hosts.
10311052
1053 - `type: "limited"`
1054
10321055 - `allowed_hosts: array of string`
10331056
10341057 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
10351058
1036 - `type: "limited"`
1037
10381059 - `secret_name: string`
10391060
10401061 Name of the environment variable.
10411062
1042 - `type: "environment_variable"`
1043
10441063 - `created_at: string`
10451064
10461065 A timestamp in RFC 3339 format
from line 1070
10511070
10521071 Arbitrary key-value metadata attached to the credential.
10531072
1054 - `type: "vault_credential"`
1055
10561073 - `updated_at: string`
10571074
10581075 A timestamp in RFC 3339 format
from line 1134
11171134
11181135 - `string`
11191136
1120 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1137 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
11211138
11221139 - `"message-batches-2024-09-24"`
11231140
from line 1182
11651182
11661183 - `"user-profiles-2026-08-18"`
11671184
1185 - `"user-profiles-2026-09-04"`
1186
11681187 - `"advisor-tool-2026-03-01"`
11691188
11701189 - `"managed-agents-2026-04-01"`
from line 1226
12071226
12081227 - `"mid-conversation-system-clear-at-2026-08-21"`
12091228
1229- `"anthropic-workspace-id": optional string`
1230
12101231### Body parameters
12111232
12121233- `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams`
from line 1260
12391260
12401261 Updated OAuth refresh token.
12411262
1242 minLength: 1, maxLength: 4096
1263 minLength: 1, maxLength: 8192
12431264
12441265 - `scope: optional string or null`
12451266
from line 1340
13191340
13201341 Substitute the secret only on requests to the listed hosts.
13211342
1343 - `type: "limited"`
1344
13221345 - `allowed_hosts: array of string`
13231346
13241347 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
13251348
1326 - `type: "limited"`
1327
13281349 - `secret_value: optional string or null`
13291350
13301351 Updated secret value.
from line 1368
13471368
13481369 A credential stored in a vault. Sensitive fields are never returned in responses.
13491370
1371 - `type: "vault_credential"`
1372
13501373 - `id: string`
13511374
13521375 Unique identifier for the credential.
from line 1388
13651388
13661389 OAuth credential details for an MCP server.
13671390
1391 - `type: "mcp_oauth"`
1392
13681393 - `mcp_server_url: string`
13691394
13701395 URL of the MCP server this credential authenticates against.
13711396
1372 - `type: "mcp_oauth"`
1373
13741397 - `expires_at: optional string or null`
13751398
13761399 A timestamp in RFC 3339 format
from line 1446
14231446
14241447 Static bearer token credential details for an MCP server.
14251448
1449 - `type: "static_bearer"`
1450
14261451 - `mcp_server_url: string`
14271452
14281453 URL of the MCP server this credential authenticates against.
14291454
1430 - `type: "static_bearer"`
1431
14321455 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
14331456
14341457 Environment variable credential details. The secret value is never returned.
14351458
1459 - `type: "environment_variable"`
1460
14361461 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
14371462
14381463 Where in the outbound request the secret value is substituted.
from line 1484
14591484
14601485 The secret is substituted only on requests to the listed hosts.
14611486
1487 - `type: "limited"`
1488
14621489 - `allowed_hosts: array of string`
14631490
14641491 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
14651492
1466 - `type: "limited"`
1467
14681493 - `secret_name: string`
14691494
14701495 Name of the environment variable.
14711496
1472 - `type: "environment_variable"`
1473
14741497 - `created_at: string`
14751498
14761499 A timestamp in RFC 3339 format
from line 1504
14811504
14821505 Arbitrary key-value metadata attached to the credential.
14831506
1484 - `type: "vault_credential"`
1485
14861507 - `updated_at: string`
14871508
14881509 A timestamp in RFC 3339 format
from line 1575
15541575
15551576 - `string`
15561577
1557 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1578 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
15581579
15591580 - `"message-batches-2024-09-24"`
15601581
from line 1623
16021623
16031624 - `"user-profiles-2026-08-18"`
16041625
1626 - `"user-profiles-2026-09-04"`
1627
16051628 - `"advisor-tool-2026-03-01"`
16061629
16071630 - `"managed-agents-2026-04-01"`
from line 1667
16441667
16451668 - `"mid-conversation-system-clear-at-2026-08-21"`
16461669
1670- `"anthropic-workspace-id": optional string`
1671
16471672### Returns
16481673
16491674- `BetaManagedAgentsDeletedCredential object`
from line 1675
16501675
16511676 Confirmation of a deleted credential.
16521677
1678 - `type: "vault_credential_deleted"`
1679
16531680 - `id: string`
16541681
16551682 Unique identifier of the deleted credential.
16561683
1657 - `type: "vault_credential_deleted"`
1658
16591684### Example
16601685
16611686```bash
from line 1720
16951720
16961721 - `string`
16971722
1698 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1723 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
16991724
17001725 - `"message-batches-2024-09-24"`
17011726
from line 1768
17431768
17441769 - `"user-profiles-2026-08-18"`
17451770
1771 - `"user-profiles-2026-09-04"`
1772
17461773 - `"advisor-tool-2026-03-01"`
17471774
17481775 - `"managed-agents-2026-04-01"`
from line 1812
17851812
17861813 - `"mid-conversation-system-clear-at-2026-08-21"`
17871814
1815- `"anthropic-workspace-id": optional string`
1816
17881817### Returns
17891818
17901819- `BetaManagedAgentsCredential object`
from line 1820
17911820
17921821 A credential stored in a vault. Sensitive fields are never returned in responses.
17931822
1823 - `type: "vault_credential"`
1824
17941825 - `id: string`
17951826
17961827 Unique identifier for the credential.
from line 1840
18091840
18101841 OAuth credential details for an MCP server.
18111842
1843 - `type: "mcp_oauth"`
1844
18121845 - `mcp_server_url: string`
18131846
18141847 URL of the MCP server this credential authenticates against.
18151848
1816 - `type: "mcp_oauth"`
1817
18181849 - `expires_at: optional string or null`
18191850
18201851 A timestamp in RFC 3339 format
from line 1898
18671898
18681899 Static bearer token credential details for an MCP server.
18691900
1901 - `type: "static_bearer"`
1902
18701903 - `mcp_server_url: string`
18711904
18721905 URL of the MCP server this credential authenticates against.
18731906
1874 - `type: "static_bearer"`
1875
18761907 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
18771908
18781909 Environment variable credential details. The secret value is never returned.
18791910
1911 - `type: "environment_variable"`
1912
18801913 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
18811914
18821915 Where in the outbound request the secret value is substituted.
from line 1936
19031936
19041937 The secret is substituted only on requests to the listed hosts.
19051938
1939 - `type: "limited"`
1940
19061941 - `allowed_hosts: array of string`
19071942
19081943 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
19091944
1910 - `type: "limited"`
1911
19121945 - `secret_name: string`
19131946
19141947 Name of the environment variable.
19151948
1916 - `type: "environment_variable"`
1917
19181949 - `created_at: string`
19191950
19201951 A timestamp in RFC 3339 format
from line 1956
19251956
19261957 Arbitrary key-value metadata attached to the credential.
19271958
1928 - `type: "vault_credential"`
1929
19301959 - `updated_at: string`
19311960
19321961 A timestamp in RFC 3339 format
from line 2021
19922021
19932022 - `string`
19942023
1995 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
2024 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
19962025
19972026 - `"message-batches-2024-09-24"`
19982027
from line 2069
20402069
20412070 - `"user-profiles-2026-08-18"`
20422071
2072 - `"user-profiles-2026-09-04"`
2073
20432074 - `"advisor-tool-2026-03-01"`
20442075
20452076 - `"managed-agents-2026-04-01"`
from line 2113
20822113
20832114 - `"mid-conversation-system-clear-at-2026-08-21"`
20842115
2116- `"anthropic-workspace-id": optional string`
2117
20852118### Returns
20862119
20872120- `BetaManagedAgentsCredentialValidation object`
from line 2121
20882121
20892122 Result of live-probing a credential against its configured MCP server.
20902123
2124 - `type: "vault_credential_validation"`
2125
20912126 - `credential_id: string`
20922127
20932128 Unique identifier of the credential that was validated.
from line 2191
21562191
21572192 - `"unknown"`
21582193
2159 - `type: "vault_credential_validation"`
2160
21612194 - `validated_at: string`
21622195
21632196 A timestamp in RFC 3339 format
from line 2250
22172250
22182251 A credential stored in a vault. Sensitive fields are never returned in responses.
22192252
2253 - `type: "vault_credential"`
2254
22202255 - `id: string`
22212256
22222257 Unique identifier for the credential.
from line 2270
22352270
22362271 OAuth credential details for an MCP server.
22372272
2273 - `type: "mcp_oauth"`
2274
22382275 - `mcp_server_url: string`
22392276
22402277 URL of the MCP server this credential authenticates against.
22412278
2242 - `type: "mcp_oauth"`
2243
22442279 - `expires_at: optional string or null`
22452280
22462281 A timestamp in RFC 3339 format
from line 2328
22932328
22942329 Static bearer token credential details for an MCP server.
22952330
2331 - `type: "static_bearer"`
2332
22962333 - `mcp_server_url: string`
22972334
22982335 URL of the MCP server this credential authenticates against.
22992336
2300 - `type: "static_bearer"`
2301
23022337 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
23032338
23042339 Environment variable credential details. The secret value is never returned.
23052340
2341 - `type: "environment_variable"`
2342
23062343 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
23072344
23082345 Where in the outbound request the secret value is substituted.
from line 2366
23292366
23302367 The secret is substituted only on requests to the listed hosts.
23312368
2369 - `type: "limited"`
2370
23322371 - `allowed_hosts: array of string`
23332372
23342373 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
23352374
2336 - `type: "limited"`
2337
23382375 - `secret_name: string`
23392376
23402377 Name of the environment variable.
23412378
2342 - `type: "environment_variable"`
2343
23442379 - `created_at: string`
23452380
23462381 A timestamp in RFC 3339 format
from line 2386
23512386
23522387 Arbitrary key-value metadata attached to the credential.
23532388
2354 - `type: "vault_credential"`
2355
23562389 - `updated_at: string`
23572390
23582391 A timestamp in RFC 3339 format
from line 2416
23832416
23842417 Substitute the secret only on requests to the listed hosts.
23852418
2419 - `type: "limited"`
2420
23862421 - `allowed_hosts: array of string`
23872422
23882423 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
23892424
2390 - `type: "limited"`
2391
23922425### Beta Managed Agents Credential Validation
23932426
23942427- `BetaManagedAgentsCredentialValidation object`
from line 2428
23952428
23962429 Result of live-probing a credential against its configured MCP server.
23972430
2431 - `type: "vault_credential_validation"`
2432
23982433 - `credential_id: string`
23992434
24002435 Unique identifier of the credential that was validated.
from line 2498
24632498
24642499 - `"unknown"`
24652500
2466 - `type: "vault_credential_validation"`
2467
24682501 - `validated_at: string`
24692502
24702503 A timestamp in RFC 3339 format
from line 2526
24932526
24942527 Confirmation of a deleted credential.
24952528
2529 - `type: "vault_credential_deleted"`
2530
24962531 - `id: string`
24972532
24982533 Unique identifier of the deleted credential.
24992534
2500 - `type: "vault_credential_deleted"`
2501
25022535### Beta Managed Agents Environment Variable Auth Response
25032536
25042537- `BetaManagedAgentsEnvironmentVariableAuthResponse object`
from line 2538
25052538
25062539 Environment variable credential details. The secret value is never returned.
25072540
2541 - `type: "environment_variable"`
2542
25082543 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
25092544
25102545 Where in the outbound request the secret value is substituted.
from line 2566
25312566
25322567 The secret is substituted only on requests to the listed hosts.
25332568
2569 - `type: "limited"`
2570
25342571 - `allowed_hosts: array of string`
25352572
25362573 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
25372574
2538 - `type: "limited"`
2539
25402575 - `secret_name: string`
25412576
25422577 Name of the environment variable.
25432578
2544 - `type: "environment_variable"`
2545
25462579### Beta Managed Agents Environment Variable Create Params
25472580
25482581- `BetaManagedAgentsEnvironmentVariableCreateParams object`
from line 2582
25492582
25502583 Parameters for creating an environment variable credential.
25512584
2585 - `type: "environment_variable"`
2586
25522587 - `networking: BetaManagedAgentsCredentialNetworkingParams`
25532588
25542589 Outbound hosts the secret value is substituted on.
from line 2598
25632598
25642599 Substitute the secret only on requests to the listed hosts.
25652600
2601 - `type: "limited"`
2602
25662603 - `allowed_hosts: array of string`
25672604
25682605 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
25692606
2570 - `type: "limited"`
2571
25722607 - `secret_name: string`
25732608
25742609 Name of the environment variable. Immutable after create.
from line 2616
25812616
25822617 minLength: 1, maxLength: 4096
25832618
2584 - `type: "environment_variable"`
2585
25862619 - `injection_location: optional BetaManagedAgentsInjectionLocationParams`
25872620
25882621 Where in the outbound request the secret value may be substituted.
from line 2662
26292662
26302663 Substitute the secret only on requests to the listed hosts.
26312664
2665 - `type: "limited"`
2666
26322667 - `allowed_hosts: array of string`
26332668
26342669 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
26352670
2636 - `type: "limited"`
2637
26382671 - `secret_value: optional string or null`
26392672
26402673 Updated secret value.
from line 2722
26892722
26902723 Substitute the secret only on requests to the listed hosts.
26912724
2725 - `type: "limited"`
2726
26922727 - `allowed_hosts: array of string`
26932728
26942729 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
26952730
2696 - `type: "limited"`
2697
26982731### Beta Managed Agents Limited Credential Networking Response
26992732
27002733- `BetaManagedAgentsLimitedCredentialNetworkingResponse object`
from line 2734
27012734
27022735 The secret is substituted only on requests to the listed hosts.
27032736
2737 - `type: "limited"`
2738
27042739 - `allowed_hosts: array of string`
27052740
27062741 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
27072742
2708 - `type: "limited"`
2709
27102743### Beta Managed Agents MCP OAuth Auth Response
27112744
27122745- `BetaManagedAgentsMCPOAuthAuthResponse object`
from line 2746
27132746
27142747 OAuth credential details for an MCP server.
27152748
2749 - `type: "mcp_oauth"`
2750
27162751 - `mcp_server_url: string`
27172752
27182753 URL of the MCP server this credential authenticates against.
27192754
2720 - `type: "mcp_oauth"`
2721
27222755 - `expires_at: optional string or null`
27232756
27242757 A timestamp in RFC 3339 format
from line 2806
27732806
27742807 Parameters for creating an MCP OAuth credential.
27752808
2809 - `type: "mcp_oauth"`
2810
27762811 - `access_token: string`
27772812
27782813 OAuth access token.
from line 2820
27852820
27862821 minLength: 1, maxLength: 2047
27872822
2788 - `type: "mcp_oauth"`
2789
27902823 - `expires_at: optional string or null`
27912824
27922825 A timestamp in RFC 3339 format
from line 2840
28072840
28082841 OAuth refresh token.
28092842
2810 minLength: 1, maxLength: 4096
2843 minLength: 1, maxLength: 8192
28112844
28122845 - `token_endpoint: string`
28132846
from line 2862
28292862
28302863 Token endpoint uses HTTP Basic authentication with client credentials.
28312864
2865 - `type: "client_secret_basic"`
2866
28322867 - `client_secret: string`
28332868
28342869 OAuth client secret.
from line 2870
28352870
28362871 minLength: 1, maxLength: 512
28372872
2838 - `type: "client_secret_basic"`
2839
28402873 - `BetaManagedAgentsTokenEndpointAuthPostParam object`
28412874
28422875 Token endpoint uses POST body authentication with client credentials.
28432876
2877 - `type: "client_secret_post"`
2878
28442879 - `client_secret: string`
28452880
28462881 OAuth client secret.
from line 2882
28472882
28482883 minLength: 1, maxLength: 512
28492884
2850 - `type: "client_secret_post"`
2851
28522885 - `resource: optional string or null`
28532886
28542887 OAuth resource indicator.
from line 2910
28772910
28782911 OAuth refresh token.
28792912
2880 minLength: 1, maxLength: 4096
2913 minLength: 1, maxLength: 8192
28812914
28822915 - `token_endpoint: string`
28832916
from line 2932
28992932
29002933 Token endpoint uses HTTP Basic authentication with client credentials.
29012934
2935 - `type: "client_secret_basic"`
2936
29022937 - `client_secret: string`
29032938
29042939 OAuth client secret.
from line 2940
29052940
29062941 minLength: 1, maxLength: 512
29072942
2908 - `type: "client_secret_basic"`
2909
29102943 - `BetaManagedAgentsTokenEndpointAuthPostParam object`
29112944
29122945 Token endpoint uses POST body authentication with client credentials.
29132946
2947 - `type: "client_secret_post"`
2948
29142949 - `client_secret: string`
29152950
29162951 OAuth client secret.
from line 2952
29172952
29182953 minLength: 1, maxLength: 512
29192954
2920 - `type: "client_secret_post"`
2921
29222955 - `resource: optional string or null`
29232956
29242957 OAuth resource indicator.
from line 3018
29853018
29863019 Updated OAuth refresh token.
29873020
2988 minLength: 1, maxLength: 4096
3021 minLength: 1, maxLength: 8192
29893022
29903023 - `scope: optional string or null`
29913024
from line 3082
30493082
30503083 Updated OAuth refresh token.
30513084
3052 minLength: 1, maxLength: 4096
3085 minLength: 1, maxLength: 8192
30533086
30543087 - `scope: optional string or null`
30553088
from line 3220
31873220
31883221 Static bearer token credential details for an MCP server.
31893222
3223 - `type: "static_bearer"`
3224
31903225 - `mcp_server_url: string`
31913226
31923227 URL of the MCP server this credential authenticates against.
31933228
3194 - `type: "static_bearer"`
3195
31963229### Beta Managed Agents Static Bearer Create Params
31973230
31983231- `BetaManagedAgentsStaticBearerCreateParams object`
from line 3232
31993232
32003233 Parameters for creating a static bearer token credential.
32013234
3235 - `type: "static_bearer"`
3236
32023237 - `token: string`
32033238
32043239 Static bearer token value.
from line 3246
32113246
32123247 minLength: 1, maxLength: 2047
32133248
3214 - `type: "static_bearer"`
3215
32163249### Beta Managed Agents Static Bearer Update Params
32173250
32183251- `BetaManagedAgentsStaticBearerUpdateParams object`
from line 3266
32333266
32343267 Token endpoint uses HTTP Basic authentication with client credentials.
32353268
3269 - `type: "client_secret_basic"`
3270
32363271 - `client_secret: string`
32373272
32383273 OAuth client secret.
from line 3274
32393274
32403275 minLength: 1, maxLength: 512
32413276
3242 - `type: "client_secret_basic"`
3243
32443277### Beta Managed Agents Token Endpoint Auth Basic Response
32453278
32463279- `BetaManagedAgentsTokenEndpointAuthBasicResponse object`
from line 3318
32853318
32863319 Token endpoint uses POST body authentication with client credentials.
32873320
3321 - `type: "client_secret_post"`
3322
32883323 - `client_secret: string`
32893324
32903325 OAuth client secret.
32913326
32923327 minLength: 1, maxLength: 512
3293
3294 - `type: "client_secret_post"`
32953328
32963329### Beta Managed Agents Token Endpoint Auth Post Response
32973330
api/beta/vaults/credentials/archive Changed · +20 / -11 lines
from line 1
1---
2title: Archive Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive
4---
5
16# Archive Credential
27
38**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/archive`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaManagedAgentsCredential object`
from line 123
114123
115124 A credential stored in a vault. Sensitive fields are never returned in responses.
116125
126 - `type: "vault_credential"`
127
117128 - `id: string`
118129
119130 Unique identifier for the credential.
from line 143
132143
133144 OAuth credential details for an MCP server.
134145
146 - `type: "mcp_oauth"`
147
135148 - `mcp_server_url: string`
136149
137150 URL of the MCP server this credential authenticates against.
138151
139 - `type: "mcp_oauth"`
140
141152 - `expires_at: optional string or null`
142153
143154 A timestamp in RFC 3339 format
from line 201
190201
191202 Static bearer token credential details for an MCP server.
192203
204 - `type: "static_bearer"`
205
193206 - `mcp_server_url: string`
194207
195208 URL of the MCP server this credential authenticates against.
196209
197 - `type: "static_bearer"`
198
199210 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
200211
201212 Environment variable credential details. The secret value is never returned.
202213
214 - `type: "environment_variable"`
215
203216 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
204217
205218 Where in the outbound request the secret value is substituted.
from line 239
226239
227240 The secret is substituted only on requests to the listed hosts.
228241
242 - `type: "limited"`
243
229244 - `allowed_hosts: array of string`
230245
231246 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
232247
233 - `type: "limited"`
234
235248 - `secret_name: string`
236249
237250 Name of the environment variable.
238251
239 - `type: "environment_variable"`
240
241252 - `created_at: string`
242253
243254 A timestamp in RFC 3339 format
from line 258
247258 - `metadata: map[string]`
248259
249260 Arbitrary key-value metadata attached to the credential.
250
251 - `type: "vault_credential"`
252261
253262 - `updated_at: string`
254263
api/beta/vaults/credentials/create Changed · +33 / -24 lines
from line 1
1---
2title: Create Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/create
4---
5
16# Create Credential
27
38**POST** `/v1/vaults/{vault_id}/credentials`
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## Body parameters
110119
111120- `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams`
from line 125
116125
117126 Parameters for creating an MCP OAuth credential.
118127
128 - `type: "mcp_oauth"`
129
119130 - `access_token: string`
120131
121132 OAuth access token.
from line 139
128139
129140 minLength: 1, maxLength: 2047
130141
131 - `type: "mcp_oauth"`
132
133142 - `expires_at: optional string or null`
134143
135144 A timestamp in RFC 3339 format
from line 159
150159
151160 OAuth refresh token.
152161
153 minLength: 1, maxLength: 4096
162 minLength: 1, maxLength: 8192
154163
155164 - `token_endpoint: string`
156165
from line 181
172181
173182 Token endpoint uses HTTP Basic authentication with client credentials.
174183
184 - `type: "client_secret_basic"`
185
175186 - `client_secret: string`
176187
177188 OAuth client secret.
from line 189
178189
179190 minLength: 1, maxLength: 512
180191
181 - `type: "client_secret_basic"`
182
183192 - `BetaManagedAgentsTokenEndpointAuthPostParam object`
184193
185194 Token endpoint uses POST body authentication with client credentials.
186195
196 - `type: "client_secret_post"`
197
187198 - `client_secret: string`
188199
189200 OAuth client secret.
from line 201
190201
191202 minLength: 1, maxLength: 512
192203
193 - `type: "client_secret_post"`
194
195204 - `resource: optional string or null`
196205
197206 OAuth resource indicator.
from line 217
208217
209218 Parameters for creating a static bearer token credential.
210219
220 - `type: "static_bearer"`
221
211222 - `token: string`
212223
213224 Static bearer token value.
from line 231
220231
221232 minLength: 1, maxLength: 2047
222233
223 - `type: "static_bearer"`
224
225234 - `BetaManagedAgentsEnvironmentVariableCreateParams object`
226235
227236 Parameters for creating an environment variable credential.
228237
238 - `type: "environment_variable"`
239
229240 - `networking: BetaManagedAgentsCredentialNetworkingParams`
230241
231242 Outbound hosts the secret value is substituted on.
from line 251
240251
241252 Substitute the secret only on requests to the listed hosts.
242253
254 - `type: "limited"`
255
243256 - `allowed_hosts: array of string`
244257
245258 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
246259
247 - `type: "limited"`
248
249260 - `secret_name: string`
250261
251262 Name of the environment variable. Immutable after create.
from line 269
258269
259270 minLength: 1, maxLength: 4096
260271
261 - `type: "environment_variable"`
262
263272 - `injection_location: optional BetaManagedAgentsInjectionLocationParams`
264273
265274 Where in the outbound request the secret value may be substituted.
from line 297
288297
289298 A credential stored in a vault. Sensitive fields are never returned in responses.
290299
300 - `type: "vault_credential"`
301
291302 - `id: string`
292303
293304 Unique identifier for the credential.
from line 317
306317
307318 OAuth credential details for an MCP server.
308319
320 - `type: "mcp_oauth"`
321
309322 - `mcp_server_url: string`
310323
311324 URL of the MCP server this credential authenticates against.
312325
313 - `type: "mcp_oauth"`
314
315326 - `expires_at: optional string or null`
316327
317328 A timestamp in RFC 3339 format
from line 375
364375
365376 Static bearer token credential details for an MCP server.
366377
378 - `type: "static_bearer"`
379
367380 - `mcp_server_url: string`
368381
369382 URL of the MCP server this credential authenticates against.
370383
371 - `type: "static_bearer"`
372
373384 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
374385
375386 Environment variable credential details. The secret value is never returned.
376387
388 - `type: "environment_variable"`
389
377390 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
378391
379392 Where in the outbound request the secret value is substituted.
from line 413
400413
401414 The secret is substituted only on requests to the listed hosts.
402415
416 - `type: "limited"`
417
403418 - `allowed_hosts: array of string`
404419
405420 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
406421
407 - `type: "limited"`
408
409422 - `secret_name: string`
410423
411424 Name of the environment variable.
412425
413 - `type: "environment_variable"`
414
415426 - `created_at: string`
416427
417428 A timestamp in RFC 3339 format
from line 432
421432 - `metadata: map[string]`
422433
423434 Arbitrary key-value metadata attached to the credential.
424
425 - `type: "vault_credential"`
426435
427436 - `updated_at: string`
428437
api/beta/vaults/credentials/delete Changed · +12 / -3 lines
from line 1
1---
2title: Delete Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete
4---
5
16# Delete Credential
27
38**DELETE** `/v1/vaults/{vault_id}/credentials/{credential_id}`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaManagedAgentsDeletedCredential object`
from line 123
114123
115124 Confirmation of a deleted credential.
116125
126 - `type: "vault_credential_deleted"`
127
117128 - `id: string`
118129
119130 Unique identifier of the deleted credential.
120
121 - `type: "vault_credential_deleted"`
122131
123132## Example
124133
api/beta/vaults/credentials/list Changed · +20 / -11 lines
from line 1
1---
2title: List Credentials
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/list
4---
5
16# List Credentials
27
38**GET** `/v1/vaults/{vault_id}/credentials`
from line 37
3237
3338 - `string`
3439
35 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3641
3742 - `"message-batches-2024-09-24"`
3843
from line 85
8085
8186 - `"user-profiles-2026-08-18"`
8287
88 - `"user-profiles-2026-09-04"`
89
8390 - `"advisor-tool-2026-03-01"`
8491
8592 - `"managed-agents-2026-04-01"`
from line 129
122129
123130 - `"mid-conversation-system-clear-at-2026-08-21"`
124131
132- `"anthropic-workspace-id": optional string`
133
125134## Returns
126135
127136- `data: optional array of BetaManagedAgentsCredential`
from line 137
128137
129138 List of credentials.
130139
140 - `type: "vault_credential"`
141
131142 - `id: string`
132143
133144 Unique identifier for the credential.
from line 157
146157
147158 OAuth credential details for an MCP server.
148159
160 - `type: "mcp_oauth"`
161
149162 - `mcp_server_url: string`
150163
151164 URL of the MCP server this credential authenticates against.
152165
153 - `type: "mcp_oauth"`
154
155166 - `expires_at: optional string or null`
156167
157168 A timestamp in RFC 3339 format
from line 215
204215
205216 Static bearer token credential details for an MCP server.
206217
218 - `type: "static_bearer"`
219
207220 - `mcp_server_url: string`
208221
209222 URL of the MCP server this credential authenticates against.
210223
211 - `type: "static_bearer"`
212
213224 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
214225
215226 Environment variable credential details. The secret value is never returned.
216227
228 - `type: "environment_variable"`
229
217230 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
218231
219232 Where in the outbound request the secret value is substituted.
from line 253
240253
241254 The secret is substituted only on requests to the listed hosts.
242255
256 - `type: "limited"`
257
243258 - `allowed_hosts: array of string`
244259
245260 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
246261
247 - `type: "limited"`
248
249262 - `secret_name: string`
250263
251264 Name of the environment variable.
252265
253 - `type: "environment_variable"`
254
255266 - `created_at: string`
256267
257268 A timestamp in RFC 3339 format
from line 272
261272 - `metadata: map[string]`
262273
263274 Arbitrary key-value metadata attached to the credential.
264
265 - `type: "vault_credential"`
266275
267276 - `updated_at: string`
268277
api/beta/vaults/credentials/mcp_oauth_validate Changed · +12 / -3 lines
from line 1
1---
2title: Validate Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate
4---
5
16# Validate Credential
27
38**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaManagedAgentsCredentialValidation object`
from line 123
114123
115124 Result of live-probing a credential against its configured MCP server.
116125
126 - `type: "vault_credential_validation"`
127
117128 - `credential_id: string`
118129
119130 Unique identifier of the credential that was validated.
from line 192
181192 - `"invalid"`
182193
183194 - `"unknown"`
184
185 - `type: "vault_credential_validation"`
186195
187196 - `validated_at: string`
188197
api/beta/vaults/credentials/retrieve Changed · +20 / -11 lines
from line 1
1---
2title: Get Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve
4---
5
16# Get Credential
27
38**GET** `/v1/vaults/{vault_id}/credentials/{credential_id}`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaManagedAgentsCredential object`
from line 123
114123
115124 A credential stored in a vault. Sensitive fields are never returned in responses.
116125
126 - `type: "vault_credential"`
127
117128 - `id: string`
118129
119130 Unique identifier for the credential.
from line 143
132143
133144 OAuth credential details for an MCP server.
134145
146 - `type: "mcp_oauth"`
147
135148 - `mcp_server_url: string`
136149
137150 URL of the MCP server this credential authenticates against.
138151
139 - `type: "mcp_oauth"`
140
141152 - `expires_at: optional string or null`
142153
143154 A timestamp in RFC 3339 format
from line 201
190201
191202 Static bearer token credential details for an MCP server.
192203
204 - `type: "static_bearer"`
205
193206 - `mcp_server_url: string`
194207
195208 URL of the MCP server this credential authenticates against.
196209
197 - `type: "static_bearer"`
198
199210 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
200211
201212 Environment variable credential details. The secret value is never returned.
202213
214 - `type: "environment_variable"`
215
203216 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
204217
205218 Where in the outbound request the secret value is substituted.
from line 239
226239
227240 The secret is substituted only on requests to the listed hosts.
228241
242 - `type: "limited"`
243
229244 - `allowed_hosts: array of string`
230245
231246 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
232247
233 - `type: "limited"`
234
235248 - `secret_name: string`
236249
237250 Name of the environment variable.
238251
239 - `type: "environment_variable"`
240
241252 - `created_at: string`
242253
243254 A timestamp in RFC 3339 format
from line 258
247258 - `metadata: map[string]`
248259
249260 Arbitrary key-value metadata attached to the credential.
250
251 - `type: "vault_credential"`
252261
253262 - `updated_at: string`
254263
api/beta/vaults/credentials/update Changed · +23 / -14 lines
from line 1
1---
2title: Update Credential
3url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/update
4---
5
16# Update Credential
27
38**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Body parameters
112121
113122- `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams`
from line 149
140149
141150 Updated OAuth refresh token.
142151
143 minLength: 1, maxLength: 4096
152 minLength: 1, maxLength: 8192
144153
145154 - `scope: optional string or null`
146155
from line 229
220229
221230 Substitute the secret only on requests to the listed hosts.
222231
232 - `type: "limited"`
233
223234 - `allowed_hosts: array of string`
224235
225236 Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries.
226237
227 - `type: "limited"`
228
229238 - `secret_value: optional string or null`
230239
231240 Updated secret value.
from line 257
248257
249258 A credential stored in a vault. Sensitive fields are never returned in responses.
250259
260 - `type: "vault_credential"`
261
251262 - `id: string`
252263
253264 Unique identifier for the credential.
from line 277
266277
267278 OAuth credential details for an MCP server.
268279
280 - `type: "mcp_oauth"`
281
269282 - `mcp_server_url: string`
270283
271284 URL of the MCP server this credential authenticates against.
272285
273 - `type: "mcp_oauth"`
274
275286 - `expires_at: optional string or null`
276287
277288 A timestamp in RFC 3339 format
from line 335
324335
325336 Static bearer token credential details for an MCP server.
326337
338 - `type: "static_bearer"`
339
327340 - `mcp_server_url: string`
328341
329342 URL of the MCP server this credential authenticates against.
330343
331 - `type: "static_bearer"`
332
333344 - `BetaManagedAgentsEnvironmentVariableAuthResponse object`
334345
335346 Environment variable credential details. The secret value is never returned.
336347
348 - `type: "environment_variable"`
349
337350 - `injection_location: BetaManagedAgentsInjectionLocationResponse`
338351
339352 Where in the outbound request the secret value is substituted.
from line 373
360373
361374 The secret is substituted only on requests to the listed hosts.
362375
376 - `type: "limited"`
377
363378 - `allowed_hosts: array of string`
364379
365380 Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself.
366381
367 - `type: "limited"`
368
369382 - `secret_name: string`
370383
371384 Name of the environment variable.
372385
373 - `type: "environment_variable"`
374
375386 - `created_at: string`
376387
377388 A timestamp in RFC 3339 format
from line 392
381392 - `metadata: map[string]`
382393
383394 Arbitrary key-value metadata attached to the credential.
384
385 - `type: "vault_credential"`
386395
387396 - `updated_at: string`
388397
api/beta/vaults/delete Changed · +12 / -3 lines
from line 1
1---
2title: Delete Vault
3url: https://platform.claude.com/docs/en/api/beta/vaults/delete
4---
5
16# Delete Vault
27
38**DELETE** `/v1/vaults/{vault_id}`
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- `BetaManagedAgentsDeletedVault object`
from line 121
112121
113122 Confirmation of a deleted vault.
114123
124 - `type: "vault_deleted"`
125
115126 - `id: string`
116127
117128 Unique identifier of the deleted vault.
118
119 - `type: "vault_deleted"`
120129
121130## Example
122131
api/beta/vaults/list Changed · +12 / -3 lines
from line 1
1---
2title: List Vaults
3url: https://platform.claude.com/docs/en/api/beta/vaults/list
4---
5
16# List Vaults
27
38**GET** `/v1/vaults`
from line 33
2833
2934 - `string`
3035
31 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
36 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3237
3338 - `"message-batches-2024-09-24"`
3439
from line 81
7681
7782 - `"user-profiles-2026-08-18"`
7883
84 - `"user-profiles-2026-09-04"`
85
7986 - `"advisor-tool-2026-03-01"`
8087
8188 - `"managed-agents-2026-04-01"`
from line 125
118125
119126 - `"mid-conversation-system-clear-at-2026-08-21"`
120127
128- `"anthropic-workspace-id": optional string`
129
121130## Returns
122131
123132- `data: optional array of BetaManagedAgentsVault`
from line 133
124133
125134 List of vaults.
126135
136 - `type: "vault"`
137
127138 - `id: string`
128139
129140 Unique identifier for the vault.
from line 158
147158 - `metadata: map[string]`
148159
149160 Arbitrary key-value metadata attached to the vault.
150
151 - `type: "vault"`
152161
153162 - `updated_at: string`
154163
api/beta/vaults/retrieve Changed · +12 / -3 lines
from line 1
1---
2title: Get Vault
3url: https://platform.claude.com/docs/en/api/beta/vaults/retrieve
4---
5
16# Get Vault
27
38**GET** `/v1/vaults/{vault_id}`
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- `BetaManagedAgentsVault object`
from line 121
112121
113122 A vault that stores credentials for use by agents during sessions.
114123
124 - `type: "vault"`
125
115126 - `id: string`
116127
117128 Unique identifier for the vault.
from line 146
135146 - `metadata: map[string]`
136147
137148 Arbitrary key-value metadata attached to the vault.
138
139 - `type: "vault"`
140149
141150 - `updated_at: string`
142151
api/beta/vaults/update Changed · +12 / -3 lines
from line 1
1---
2title: Update Vault
3url: https://platform.claude.com/docs/en/api/beta/vaults/update
4---
5
16# Update Vault
27
38**POST** `/v1/vaults/{vault_id}`
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## Body parameters
110119
111120- `display_name: optional string or null`
from line 133
124133
125134 A vault that stores credentials for use by agents during sessions.
126135
136 - `type: "vault"`
137
127138 - `id: string`
128139
129140 Unique identifier for the vault.
from line 158
147158 - `metadata: map[string]`
148159
149160 Arbitrary key-value metadata attached to the vault.
150
151 - `type: "vault"`
152161
153162 - `updated_at: string`
154163
api/beta/webhooks Changed · +275 / -270 lines
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Webhooks
3url: https://platform.claude.com/docs/en/api/beta/webhooks
4---
5
16# Webhooks
27
38## Unwrap
from line 22
1722
1823- `BetaWebhookAgentArchivedEventData object`
1924
25 - `type: "agent.archived"`
26
2027 - `id: string`
2128
2229 ID of the agent that triggered the event.
2330
2431 - `organization_id: string`
2532
26 - `type: "agent.archived"`
27
2833 - `workspace_id: string`
2934
3035### Beta Webhook Agent Created Event Data
3136
3237- `BetaWebhookAgentCreatedEventData object`
3338
39 - `type: "agent.created"`
40
3441 - `id: string`
3542
3643 ID of the agent that triggered the event.
3744
3845 - `organization_id: string`
3946
40 - `type: "agent.created"`
41
4247 - `workspace_id: string`
4348
4449### Beta Webhook Agent Deleted Event Data
4550
4651- `BetaWebhookAgentDeletedEventData object`
4752
53 - `type: "agent.deleted"`
54
4855 - `id: string`
4956
5057 ID of the agent that triggered the event.
5158
5259 - `organization_id: string`
5360
54 - `type: "agent.deleted"`
55
5661 - `workspace_id: string`
5762
5863### Beta Webhook Agent Updated Event Data
5964
6065- `BetaWebhookAgentUpdatedEventData object`
6166
67 - `type: "agent.updated"`
68
6269 - `id: string`
6370
6471 ID of the agent that triggered the event.
6572
6673 - `organization_id: string`
6774
68 - `type: "agent.updated"`
69
7075 - `workspace_id: string`
7176
7277### Beta Webhook Deployment Archived Event Data
7378
7479- `BetaWebhookDeploymentArchivedEventData object`
7580
81 - `type: "deployment.archived"`
82
7683 - `id: string`
7784
7885 ID of the deployment that triggered the event.
7986
8087 - `organization_id: string`
8188
82 - `type: "deployment.archived"`
83
8489 - `workspace_id: string`
8590
8691### Beta Webhook Deployment Created Event Data
8792
8893- `BetaWebhookDeploymentCreatedEventData object`
8994
95 - `type: "deployment.created"`
96
9097 - `id: string`
9198
9299 ID of the deployment that triggered the event.
93100
94101 - `organization_id: string`
95102
96 - `type: "deployment.created"`
97
98103 - `workspace_id: string`
99104
100105### Beta Webhook Deployment Deleted Event Data
101106
102107- `BetaWebhookDeploymentDeletedEventData object`
103108
109 - `type: "deployment.deleted"`
110
104111 - `id: string`
105112
106113 ID of the deployment that triggered the event.
107114
108115 - `organization_id: string`
109116
110 - `type: "deployment.deleted"`
111
112117 - `workspace_id: string`
113118
114119### Beta Webhook Deployment Paused Event Data
115120
116121- `BetaWebhookDeploymentPausedEventData object`
117122
123 - `type: "deployment.paused"`
124
118125 - `id: string`
119126
120127 ID of the deployment that triggered the event.
121128
122129 - `organization_id: string`
123130
124 - `type: "deployment.paused"`
125
126131 - `workspace_id: string`
127132
128133### Beta Webhook Deployment Run Failed Event Data
129134
130135- `BetaWebhookDeploymentRunFailedEventData object`
131136
137 - `type: "deployment_run.failed"`
138
132139 - `id: string`
133140
134141 ID of the deployment run that triggered the event.
135142
136143 - `organization_id: string`
137144
138 - `type: "deployment_run.failed"`
139
140145 - `workspace_id: string`
141146
142147### Beta Webhook Deployment Run Started Event Data
143148
144149- `BetaWebhookDeploymentRunStartedEventData object`
145150
151 - `type: "deployment_run.started"`
152
146153 - `id: string`
147154
148155 ID of the deployment run that triggered the event.
149156
150157 - `organization_id: string`
151158
152 - `type: "deployment_run.started"`
153
154159 - `workspace_id: string`
155160
156161### Beta Webhook Deployment Run Succeeded Event Data
157162
158163- `BetaWebhookDeploymentRunSucceededEventData object`
159164
165 - `type: "deployment_run.succeeded"`
166
160167 - `id: string`
161168
162169 ID of the deployment run that triggered the event.
163170
164171 - `organization_id: string`
165172
166 - `type: "deployment_run.succeeded"`
167
168173 - `workspace_id: string`
169174
170175### Beta Webhook Deployment Unpaused Event Data
171176
172177- `BetaWebhookDeploymentUnpausedEventData object`
173178
179 - `type: "deployment.unpaused"`
180
174181 - `id: string`
175182
176183 ID of the deployment that triggered the event.
177184
178185 - `organization_id: string`
179186
180 - `type: "deployment.unpaused"`
181
182187 - `workspace_id: string`
183188
184189### Beta Webhook Deployment Updated Event Data
185190
186191- `BetaWebhookDeploymentUpdatedEventData object`
187192
193 - `type: "deployment.updated"`
194
188195 - `id: string`
189196
190197 ID of the deployment that triggered the event.
191198
192199 - `organization_id: string`
193200
194 - `type: "deployment.updated"`
195
196201 - `workspace_id: string`
197202
198203### Beta Webhook Environment Archived Event Data
199204
200205- `BetaWebhookEnvironmentArchivedEventData object`
201206
207 - `type: "environment.archived"`
208
202209 - `id: string`
203210
204211 ID of the environment that triggered the event.
205212
206213 - `organization_id: string`
207214
208 - `type: "environment.archived"`
209
210215 - `workspace_id: string`
211216
212217### Beta Webhook Environment Created Event Data
213218
214219- `BetaWebhookEnvironmentCreatedEventData object`
215220
221 - `type: "environment.created"`
222
216223 - `id: string`
217224
218225 ID of the environment that triggered the event.
219226
220227 - `organization_id: string`
221228
222 - `type: "environment.created"`
223
224229 - `workspace_id: string`
225230
226231### Beta Webhook Environment Deleted Event Data
227232
228233- `BetaWebhookEnvironmentDeletedEventData object`
229234
235 - `type: "environment.deleted"`
236
230237 - `id: string`
231238
232239 ID of the environment that triggered the event.
233240
234241 - `organization_id: string`
235242
236 - `type: "environment.deleted"`
237
238243 - `workspace_id: string`
239244
240245### Beta Webhook Environment Updated Event Data
241246
242247- `BetaWebhookEnvironmentUpdatedEventData object`
243248
249 - `type: "environment.updated"`
250
244251 - `id: string`
245252
246253 ID of the environment that triggered the event.
247254
248255 - `organization_id: string`
249256
250 - `type: "environment.updated"`
251
252257 - `workspace_id: string`
253258
254259### Beta Webhook Event
255260
256261- `BetaWebhookEvent object`
257262
263 - `type: "event"`
264
265 Object type. Always `event` for webhook payloads.
266
258267 - `id: string`
259268
260269 Unique event identifier for idempotency.
from line 278
269278
270279 - `BetaWebhookSessionCreatedEventData object`
271280
281 - `type: "session.created"`
282
272283 - `id: string`
273284
274285 ID of the session that triggered the event.
275286
276287 - `organization_id: string`
277288
278 - `type: "session.created"`
279
280289 - `workspace_id: string`
281290
282291 - `BetaWebhookSessionPendingEventData object`
283292
293 - `type: "session.pending"`
294
284295 - `id: string`
285296
286297 ID of the session that triggered the event.
287298
288299 - `organization_id: string`
289300
290 - `type: "session.pending"`
291
292301 - `workspace_id: string`
293302
294303 - `BetaWebhookSessionRunningEventData object`
295304
305 - `type: "session.running"`
306
296307 - `id: string`
297308
298309 ID of the session that triggered the event.
299310
300311 - `organization_id: string`
301312
302 - `type: "session.running"`
303
304313 - `workspace_id: string`
305314
306315 - `BetaWebhookSessionIdledEventData object`
307316
317 - `type: "session.idled"`
318
308319 - `id: string`
309320
310321 ID of the session that triggered the event.
311322
312323 - `organization_id: string`
313324
314 - `type: "session.idled"`
315
316325 - `workspace_id: string`
317326
318327 - `BetaWebhookSessionRequiresActionEventData object`
319328
329 - `type: "session.requires_action"`
330
320331 - `id: string`
321332
322333 ID of the session that triggered the event.
323334
324335 - `organization_id: string`
325336
326 - `type: "session.requires_action"`
327
328337 - `workspace_id: string`
329338
330339 - `BetaWebhookSessionArchivedEventData object`
331340
341 - `type: "session.archived"`
342
332343 - `id: string`
333344
334345 ID of the session that triggered the event.
335346
336347 - `organization_id: string`
337348
338 - `type: "session.archived"`
339
340349 - `workspace_id: string`
341350
342351 - `BetaWebhookSessionDeletedEventData object`
343352
353 - `type: "session.deleted"`
354
344355 - `id: string`
345356
346357 ID of the session that triggered the event.
347358
348359 - `organization_id: string`
349360
350 - `type: "session.deleted"`
351
352361 - `workspace_id: string`
353362
354363 - `BetaWebhookSessionStatusRescheduledEventData object`
355364
365 - `type: "session.status_rescheduled"`
366
356367 - `id: string`
357368
358369 ID of the session that triggered the event.
359370
360371 - `organization_id: string`
361372
362 - `type: "session.status_rescheduled"`
363
364373 - `workspace_id: string`
365374
366375 - `BetaWebhookSessionStatusRunStartedEventData object`
367376
377 - `type: "session.status_run_started"`
378
368379 - `id: string`
369380
370381 ID of the session that triggered the event.
371382
372383 - `organization_id: string`
373384
374 - `type: "session.status_run_started"`
375
376385 - `workspace_id: string`
377386
378387 - `BetaWebhookSessionStatusIdledEventData object`
379388
389 - `type: "session.status_idled"`
390
380391 - `id: string`
381392
382393 ID of the session that triggered the event.
383394
384395 - `organization_id: string`
385396
386 - `type: "session.status_idled"`
387
388397 - `workspace_id: string`
389398
390399 - `BetaWebhookSessionStatusTerminatedEventData object`
391400
401 - `type: "session.status_terminated"`
402
392403 - `id: string`
393404
394405 ID of the session that triggered the event.
395406
396407 - `organization_id: string`
397408
398 - `type: "session.status_terminated"`
399
400409 - `workspace_id: string`
401410
402411 - `BetaWebhookSessionThreadCreatedEventData object`
403412
413 - `type: "session.thread_created"`
414
404415 - `id: string`
405416
406417 ID of the session that triggered the event.
from line 422
411422
412423 ID of the session thread this event refers to.
413424
414 - `type: "session.thread_created"`
415
416425 - `workspace_id: string`
417426
418427 - `BetaWebhookSessionThreadIdledEventData object`
419428
429 - `type: "session.thread_idled"`
430
420431 - `id: string`
421432
422433 ID of the session that triggered the event.
from line 438
427438
428439 ID of the session thread this event refers to.
429440
430 - `type: "session.thread_idled"`
431
432441 - `workspace_id: string`
433442
434443 - `BetaWebhookSessionThreadTerminatedEventData object`
435444
445 - `type: "session.thread_terminated"`
446
436447 - `id: string`
437448
438449 ID of the session that triggered the event.
from line 454
443454
444455 ID of the session thread this event refers to.
445456
446 - `type: "session.thread_terminated"`
447
448457 - `workspace_id: string`
449458
450459 - `BetaWebhookSessionOutcomeEvaluationEndedEventData object`
451460
461 - `type: "session.outcome_evaluation_ended"`
462
452463 - `id: string`
453464
454465 ID of the session that triggered the event.
455466
456467 - `organization_id: string`
457468
458 - `type: "session.outcome_evaluation_ended"`
459
460469 - `workspace_id: string`
461470
462471 - `BetaWebhookVaultCreatedEventData object`
463472
473 - `type: "vault.created"`
474
464475 - `id: string`
465476
466477 ID of the vault that triggered the event.
467478
468479 - `organization_id: string`
469480
470 - `type: "vault.created"`
471
472481 - `workspace_id: string`
473482
474483 - `BetaWebhookVaultArchivedEventData object`
475484
485 - `type: "vault.archived"`
486
476487 - `id: string`
477488
478489 ID of the vault that triggered the event.
479490
480491 - `organization_id: string`
481492
482 - `type: "vault.archived"`
483
484493 - `workspace_id: string`
485494
486495 - `BetaWebhookVaultDeletedEventData object`
487496
497 - `type: "vault.deleted"`
498
488499 - `id: string`
489500
490501 ID of the vault that triggered the event.
491502
492503 - `organization_id: string`
493504
494 - `type: "vault.deleted"`
495
496505 - `workspace_id: string`
497506
498507 - `BetaWebhookVaultCredentialCreatedEventData object`
499508
509 - `type: "vault_credential.created"`
510
500511 - `id: string`
501512
502513 ID of the vault credential that triggered the event.
503514
504515 - `organization_id: string`
505516
506 - `type: "vault_credential.created"`
507
508517 - `vault_id: string`
509518
510519 ID of the vault that owns this credential.
from line 522
513522
514523 - `BetaWebhookVaultCredentialArchivedEventData object`
515524
525 - `type: "vault_credential.archived"`
526
516527 - `id: string`
517528
518529 ID of the vault credential that triggered the event.
519530
520531 - `organization_id: string`
521532
522 - `type: "vault_credential.archived"`
523
524533 - `vault_id: string`
525534
526535 ID of the vault that owns this credential.
from line 538
529538
530539 - `BetaWebhookVaultCredentialDeletedEventData object`
531540
541 - `type: "vault_credential.deleted"`
542
532543 - `id: string`
533544
534545 ID of the vault credential that triggered the event.
535546
536547 - `organization_id: string`
537548
538 - `type: "vault_credential.deleted"`
539
540549 - `vault_id: string`
541550
542551 ID of the vault that owns this credential.
from line 554
545554
546555 - `BetaWebhookVaultCredentialRefreshFailedEventData object`
547556
557 - `type: "vault_credential.refresh_failed"`
558
548559 - `id: string`
549560
550561 ID of the vault credential that triggered the event.
551562
552563 - `organization_id: string`
553564
554 - `type: "vault_credential.refresh_failed"`
555
556565 - `vault_id: string`
557566
558567 ID of the vault that owns this credential.
from line 570
561570
562571 - `BetaWebhookSessionUpdatedEventData object`
563572
573 - `type: "session.updated"`
574
564575 - `id: string`
565576
566577 ID of the session that triggered the event.
567578
568579 - `organization_id: string`
569580
570 - `type: "session.updated"`
571
572581 - `workspace_id: string`
573582
574583 - `BetaWebhookAgentCreatedEventData object`
575584
585 - `type: "agent.created"`
586
576587 - `id: string`
577588
578589 ID of the agent that triggered the event.
579590
580591 - `organization_id: string`
581592
582 - `type: "agent.created"`
583
584593 - `workspace_id: string`
585594
586595 - `BetaWebhookAgentArchivedEventData object`
587596
597 - `type: "agent.archived"`
598
588599 - `id: string`
589600
590601 ID of the agent that triggered the event.
591602
592603 - `organization_id: string`
593604
594 - `type: "agent.archived"`
595
596605 - `workspace_id: string`
597606
598607 - `BetaWebhookAgentDeletedEventData object`
599608
609 - `type: "agent.deleted"`
610
600611 - `id: string`
601612
602613 ID of the agent that triggered the event.
603614
604615 - `organization_id: string`
605616
606 - `type: "agent.deleted"`
607
608617 - `workspace_id: string`
609618
610619 - `BetaWebhookDeploymentPausedEventData object`
611620
621 - `type: "deployment.paused"`
622
612623 - `id: string`
613624
614625 ID of the deployment that triggered the event.
615626
616627 - `organization_id: string`
617628
618 - `type: "deployment.paused"`
619
620629 - `workspace_id: string`
621630
622631 - `BetaWebhookDeploymentRunFailedEventData object`
623632
633 - `type: "deployment_run.failed"`
634
624635 - `id: string`
625636
626637 ID of the deployment run that triggered the event.
627638
628639 - `organization_id: string`
629640
630 - `type: "deployment_run.failed"`
631
632641 - `workspace_id: string`
633642
634643 - `BetaWebhookDeploymentCreatedEventData object`
635644
645 - `type: "deployment.created"`
646
636647 - `id: string`
637648
638649 ID of the deployment that triggered the event.
639650
640651 - `organization_id: string`
641652
642 - `type: "deployment.created"`
643
644653 - `workspace_id: string`
645654
646655 - `BetaWebhookDeploymentUpdatedEventData object`
647656
657 - `type: "deployment.updated"`
658
648659 - `id: string`
649660
650661 ID of the deployment that triggered the event.
651662
652663 - `organization_id: string`
653664
654 - `type: "deployment.updated"`
655
656665 - `workspace_id: string`
657666
658667 - `BetaWebhookDeploymentUnpausedEventData object`
659668
669 - `type: "deployment.unpaused"`
670
660671 - `id: string`
661672
662673 ID of the deployment that triggered the event.
663674
664675 - `organization_id: string`
665676
666 - `type: "deployment.unpaused"`
667
668677 - `workspace_id: string`
669678
670679 - `BetaWebhookAgentUpdatedEventData object`
671680
681 - `type: "agent.updated"`
682
672683 - `id: string`
673684
674685 ID of the agent that triggered the event.
675686
676687 - `organization_id: string`
677688
678 - `type: "agent.updated"`
679
680689 - `workspace_id: string`
681690
682691 - `BetaWebhookDeploymentArchivedEventData object`
683692
693 - `type: "deployment.archived"`
694
684695 - `id: string`
685696
686697 ID of the deployment that triggered the event.
687698
688699 - `organization_id: string`
689700
690 - `type: "deployment.archived"`
691
692701 - `workspace_id: string`
693702
694703 - `BetaWebhookDeploymentRunStartedEventData object`
695704
705 - `type: "deployment_run.started"`
706
696707 - `id: string`
697708
698709 ID of the deployment run that triggered the event.
699710
700711 - `organization_id: string`
701712
702 - `type: "deployment_run.started"`
703
704713 - `workspace_id: string`
705714
706715 - `BetaWebhookDeploymentDeletedEventData object`
707716
717 - `type: "deployment.deleted"`
718
708719 - `id: string`
709720
710721 ID of the deployment that triggered the event.
711722
712723 - `organization_id: string`
713724
714 - `type: "deployment.deleted"`
715
716725 - `workspace_id: string`
717726
718727 - `BetaWebhookDeploymentRunSucceededEventData object`
719728
729 - `type: "deployment_run.succeeded"`
730
720731 - `id: string`
721732
722733 ID of the deployment run that triggered the event.
723734
724735 - `organization_id: string`
725736
726 - `type: "deployment_run.succeeded"`
727
728737 - `workspace_id: string`
729738
730739 - `BetaWebhookEnvironmentCreatedEventData object`
731740
741 - `type: "environment.created"`
742
732743 - `id: string`
733744
734745 ID of the environment that triggered the event.
735746
736747 - `organization_id: string`
737748
738 - `type: "environment.created"`
739
740749 - `workspace_id: string`
741750
742751 - `BetaWebhookEnvironmentUpdatedEventData object`
743752
753 - `type: "environment.updated"`
754
744755 - `id: string`
745756
746757 ID of the environment that triggered the event.
747758
748759 - `organization_id: string`
749760
750 - `type: "environment.updated"`
751
752761 - `workspace_id: string`
753762
754763 - `BetaWebhookEnvironmentArchivedEventData object`
755764
765 - `type: "environment.archived"`
766
756767 - `id: string`
757768
758769 ID of the environment that triggered the event.
759770
760771 - `organization_id: string`
761772
762 - `type: "environment.archived"`
763
764773 - `workspace_id: string`
765774
766775 - `BetaWebhookEnvironmentDeletedEventData object`
767776
777 - `type: "environment.deleted"`
778
768779 - `id: string`
769780
770781 ID of the environment that triggered the event.
771782
772783 - `organization_id: string`
773784
774 - `type: "environment.deleted"`
775
776785 - `workspace_id: string`
777786
778787 - `BetaWebhookMemoryStoreCreatedEventData object`
779788
789 - `type: "memory_store.created"`
790
780791 - `id: string`
781792
782793 ID of the memory store that triggered the event.
783794
784795 - `organization_id: string`
785796
786 - `type: "memory_store.created"`
787
788797 - `workspace_id: string`
789798
790799 - `BetaWebhookMemoryStoreArchivedEventData object`
791800
801 - `type: "memory_store.archived"`
802
792803 - `id: string`
793804
794805 ID of the memory store that triggered the event.
795806
796807 - `organization_id: string`
797808
798 - `type: "memory_store.archived"`
799
800809 - `workspace_id: string`
801810
802811 - `BetaWebhookMemoryStoreDeletedEventData object`
803812
813 - `type: "memory_store.deleted"`
814
804815 - `id: string`
805816
806817 ID of the memory store that triggered the event.
807818
808819 - `organization_id: string`
809820
810 - `type: "memory_store.deleted"`
811
812821 - `workspace_id: string`
813822
814823 - `BetaWebhookSessionBudgetReachedEventData object`
815824
825 - `type: "session.budget_reached"`
826
816827 - `id: string`
817828
818829 ID of the session that triggered the event.
819830
820831 - `organization_id: string`
821832
822 - `type: "session.budget_reached"`
823
824 - `workspace_id: string`
825
826 - `type: "event"`
827
828 Object type. Always `event` for webhook payloads.
833 - `workspace_id: string`
829834
830835### Beta Webhook Event Data
831836
from line 838
833838
834839 - `BetaWebhookSessionCreatedEventData object`
835840
841 - `type: "session.created"`
842
836843 - `id: string`
837844
838845 ID of the session that triggered the event.
839846
840847 - `organization_id: string`
841848
842 - `type: "session.created"`
843
844849 - `workspace_id: string`
845850
846851 - `BetaWebhookSessionPendingEventData object`
847852
853 - `type: "session.pending"`
854
848855 - `id: string`
849856
850857 ID of the session that triggered the event.
851858
852859 - `organization_id: string`
853860
854 - `type: "session.pending"`
855
856861 - `workspace_id: string`
857862
858863 - `BetaWebhookSessionRunningEventData object`
859864
865 - `type: "session.running"`
866
860867 - `id: string`
861868
862869 ID of the session that triggered the event.
863870
864871 - `organization_id: string`
865872
866 - `type: "session.running"`
867
868873 - `workspace_id: string`
869874
870875 - `BetaWebhookSessionIdledEventData object`
871876
877 - `type: "session.idled"`
878
872879 - `id: string`
873880
874881 ID of the session that triggered the event.
875882
876883 - `organization_id: string`
877884
878 - `type: "session.idled"`
879
880885 - `workspace_id: string`
881886
882887 - `BetaWebhookSessionRequiresActionEventData object`
883888
889 - `type: "session.requires_action"`
890
884891 - `id: string`
885892
886893 ID of the session that triggered the event.
887894
888895 - `organization_id: string`
889896
890 - `type: "session.requires_action"`
891
892897 - `workspace_id: string`
893898
894899 - `BetaWebhookSessionArchivedEventData object`
895900
901 - `type: "session.archived"`
902
896903 - `id: string`
897904
898905 ID of the session that triggered the event.
899906
900907 - `organization_id: string`
901908
902 - `type: "session.archived"`
903
904909 - `workspace_id: string`
905910
906911 - `BetaWebhookSessionDeletedEventData object`
907912
913 - `type: "session.deleted"`
914
908915 - `id: string`
909916
910917 ID of the session that triggered the event.
911918
912919 - `organization_id: string`
913920
914 - `type: "session.deleted"`
915
916921 - `workspace_id: string`
917922
918923 - `BetaWebhookSessionStatusRescheduledEventData object`
919924
925 - `type: "session.status_rescheduled"`
926
920927 - `id: string`
921928
922929 ID of the session that triggered the event.
923930
924931 - `organization_id: string`
925932
926 - `type: "session.status_rescheduled"`
927
928933 - `workspace_id: string`
929934
930935 - `BetaWebhookSessionStatusRunStartedEventData object`
931936
937 - `type: "session.status_run_started"`
938
932939 - `id: string`
933940
934941 ID of the session that triggered the event.
935942
936943 - `organization_id: string`
937944
938 - `type: "session.status_run_started"`
939
940945 - `workspace_id: string`
941946
942947 - `BetaWebhookSessionStatusIdledEventData object`
943948
949 - `type: "session.status_idled"`
950
944951 - `id: string`
945952
946953 ID of the session that triggered the event.
947954
948955 - `organization_id: string`
949956
950 - `type: "session.status_idled"`
951
952957 - `workspace_id: string`
953958
954959 - `BetaWebhookSessionStatusTerminatedEventData object`
955960
961 - `type: "session.status_terminated"`
962
956963 - `id: string`
957964
958965 ID of the session that triggered the event.
959966
960967 - `organization_id: string`
961968
962 - `type: "session.status_terminated"`
963
964969 - `workspace_id: string`
965970
966971 - `BetaWebhookSessionThreadCreatedEventData object`
967972
973 - `type: "session.thread_created"`
974
968975 - `id: string`
969976
970977 ID of the session that triggered the event.
from line 982
975982
976983 ID of the session thread this event refers to.
977984
978 - `type: "session.thread_created"`
979
980985 - `workspace_id: string`
981986
982987 - `BetaWebhookSessionThreadIdledEventData object`
983988
989 - `type: "session.thread_idled"`
990
984991 - `id: string`
985992
986993 ID of the session that triggered the event.
from line 998
991998
992999 ID of the session thread this event refers to.
9931000
994 - `type: "session.thread_idled"`
995
9961001 - `workspace_id: string`
9971002
9981003 - `BetaWebhookSessionThreadTerminatedEventData object`
9991004
1005 - `type: "session.thread_terminated"`
1006
10001007 - `id: string`
10011008
10021009 ID of the session that triggered the event.
from line 1014
10071014
10081015 ID of the session thread this event refers to.
10091016
1010 - `type: "session.thread_terminated"`
1011
10121017 - `workspace_id: string`
10131018
10141019 - `BetaWebhookSessionOutcomeEvaluationEndedEventData object`
10151020
1021 - `type: "session.outcome_evaluation_ended"`
1022
10161023 - `id: string`
10171024
10181025 ID of the session that triggered the event.
10191026
10201027 - `organization_id: string`
10211028
1022 - `type: "session.outcome_evaluation_ended"`
1023
10241029 - `workspace_id: string`
10251030
10261031 - `BetaWebhookVaultCreatedEventData object`
10271032
1033 - `type: "vault.created"`
1034
10281035 - `id: string`
10291036
10301037 ID of the vault that triggered the event.
10311038
10321039 - `organization_id: string`
10331040
1034 - `type: "vault.created"`
1035
10361041 - `workspace_id: string`
10371042
10381043 - `BetaWebhookVaultArchivedEventData object`
10391044
1045 - `type: "vault.archived"`
1046
10401047 - `id: string`
10411048
10421049 ID of the vault that triggered the event.
10431050
10441051 - `organization_id: string`
10451052
1046 - `type: "vault.archived"`
1047
10481053 - `workspace_id: string`
10491054
10501055 - `BetaWebhookVaultDeletedEventData object`
10511056
1057 - `type: "vault.deleted"`
1058
10521059 - `id: string`
10531060
10541061 ID of the vault that triggered the event.
10551062
10561063 - `organization_id: string`
10571064
1058 - `type: "vault.deleted"`
1059
10601065 - `workspace_id: string`
10611066
10621067 - `BetaWebhookVaultCredentialCreatedEventData object`
10631068
1069 - `type: "vault_credential.created"`
1070
10641071 - `id: string`
10651072
10661073 ID of the vault credential that triggered the event.
10671074
10681075 - `organization_id: string`
10691076
1070 - `type: "vault_credential.created"`
1071
10721077 - `vault_id: string`
10731078
10741079 ID of the vault that owns this credential.
from line 1082
10771082
10781083 - `BetaWebhookVaultCredentialArchivedEventData object`
10791084
1085 - `type: "vault_credential.archived"`
1086
10801087 - `id: string`
10811088
10821089 ID of the vault credential that triggered the event.
10831090
10841091 - `organization_id: string`
10851092
1086 - `type: "vault_credential.archived"`
1087
10881093 - `vault_id: string`
10891094
10901095 ID of the vault that owns this credential.
from line 1098
10931098
10941099 - `BetaWebhookVaultCredentialDeletedEventData object`
10951100
1101 - `type: "vault_credential.deleted"`
1102
10961103 - `id: string`
10971104
10981105 ID of the vault credential that triggered the event.
10991106
11001107 - `organization_id: string`
11011108
1102 - `type: "vault_credential.deleted"`
1103
11041109 - `vault_id: string`
11051110
11061111 ID of the vault that owns this credential.
from line 1114
11091114
11101115 - `BetaWebhookVaultCredentialRefreshFailedEventData object`
11111116
1117 - `type: "vault_credential.refresh_failed"`
1118
11121119 - `id: string`
11131120
11141121 ID of the vault credential that triggered the event.
11151122
11161123 - `organization_id: string`
11171124
1118 - `type: "vault_credential.refresh_failed"`
1119
11201125 - `vault_id: string`
11211126
11221127 ID of the vault that owns this credential.
from line 1130
11251130
11261131 - `BetaWebhookSessionUpdatedEventData object`
11271132
1133 - `type: "session.updated"`
1134
11281135 - `id: string`
11291136
11301137 ID of the session that triggered the event.
11311138
11321139 - `organization_id: string`
11331140
1134 - `type: "session.updated"`
1135
11361141 - `workspace_id: string`
11371142
11381143 - `BetaWebhookAgentCreatedEventData object`
11391144
1145 - `type: "agent.created"`
1146
11401147 - `id: string`
11411148
11421149 ID of the agent that triggered the event.
11431150
11441151 - `organization_id: string`
11451152
1146 - `type: "agent.created"`
1147
11481153 - `workspace_id: string`
11491154
11501155 - `BetaWebhookAgentArchivedEventData object`
11511156
1157 - `type: "agent.archived"`
1158
11521159 - `id: string`
11531160
11541161 ID of the agent that triggered the event.
11551162
11561163 - `organization_id: string`
11571164
1158 - `type: "agent.archived"`
1159
11601165 - `workspace_id: string`
11611166
11621167 - `BetaWebhookAgentDeletedEventData object`
11631168
1169 - `type: "agent.deleted"`
1170
11641171 - `id: string`
11651172
11661173 ID of the agent that triggered the event.
11671174
11681175 - `organization_id: string`
11691176
1170 - `type: "agent.deleted"`
1171
11721177 - `workspace_id: string`
11731178
11741179 - `BetaWebhookDeploymentPausedEventData object`
11751180
1181 - `type: "deployment.paused"`
1182
11761183 - `id: string`
11771184
11781185 ID of the deployment that triggered the event.
11791186
11801187 - `organization_id: string`
11811188
1182 - `type: "deployment.paused"`
1183
11841189 - `workspace_id: string`
11851190
11861191 - `BetaWebhookDeploymentRunFailedEventData object`
11871192
1193 - `type: "deployment_run.failed"`
1194
11881195 - `id: string`
11891196
11901197 ID of the deployment run that triggered the event.
11911198
11921199 - `organization_id: string`
11931200
1194 - `type: "deployment_run.failed"`
1195
11961201 - `workspace_id: string`
11971202
11981203 - `BetaWebhookDeploymentCreatedEventData object`
11991204
1205 - `type: "deployment.created"`
1206
12001207 - `id: string`
12011208
12021209 ID of the deployment that triggered the event.
12031210
12041211 - `organization_id: string`
12051212
1206 - `type: "deployment.created"`
1207
12081213 - `workspace_id: string`
12091214
12101215 - `BetaWebhookDeploymentUpdatedEventData object`
12111216
1217 - `type: "deployment.updated"`
1218
12121219 - `id: string`
12131220
12141221 ID of the deployment that triggered the event.
12151222
12161223 - `organization_id: string`
12171224
1218 - `type: "deployment.updated"`
1219
12201225 - `workspace_id: string`
12211226
12221227 - `BetaWebhookDeploymentUnpausedEventData object`
12231228
1229 - `type: "deployment.unpaused"`
1230
12241231 - `id: string`
12251232
12261233 ID of the deployment that triggered the event.
12271234
12281235 - `organization_id: string`
12291236
1230 - `type: "deployment.unpaused"`
1231
12321237 - `workspace_id: string`
12331238
12341239 - `BetaWebhookAgentUpdatedEventData object`
12351240
1241 - `type: "agent.updated"`
1242
12361243 - `id: string`
12371244
12381245 ID of the agent that triggered the event.
12391246
12401247 - `organization_id: string`
12411248
1242 - `type: "agent.updated"`
1243
12441249 - `workspace_id: string`
12451250
12461251 - `BetaWebhookDeploymentArchivedEventData object`
12471252
1253 - `type: "deployment.archived"`
1254
12481255 - `id: string`
12491256
12501257 ID of the deployment that triggered the event.
12511258
12521259 - `organization_id: string`
12531260
1254 - `type: "deployment.archived"`
1255
12561261 - `workspace_id: string`
12571262
12581263 - `BetaWebhookDeploymentRunStartedEventData object`
12591264
1265 - `type: "deployment_run.started"`
1266
12601267 - `id: string`
12611268
12621269 ID of the deployment run that triggered the event.
12631270
12641271 - `organization_id: string`
12651272
1266 - `type: "deployment_run.started"`
1267
12681273 - `workspace_id: string`
12691274
12701275 - `BetaWebhookDeploymentDeletedEventData object`
12711276
1277 - `type: "deployment.deleted"`
1278
12721279 - `id: string`
12731280
12741281 ID of the deployment that triggered the event.
12751282
12761283 - `organization_id: string`
12771284
1278 - `type: "deployment.deleted"`
1279
12801285 - `workspace_id: string`
12811286
12821287 - `BetaWebhookDeploymentRunSucceededEventData object`
12831288
1289 - `type: "deployment_run.succeeded"`
1290
12841291 - `id: string`
12851292
12861293 ID of the deployment run that triggered the event.
12871294
12881295 - `organization_id: string`
12891296
1290 - `type: "deployment_run.succeeded"`
1291
12921297 - `workspace_id: string`
12931298
12941299 - `BetaWebhookEnvironmentCreatedEventData object`
12951300
1301 - `type: "environment.created"`
1302
12961303 - `id: string`
12971304
12981305 ID of the environment that triggered the event.
12991306
13001307 - `organization_id: string`
13011308
1302 - `type: "environment.created"`
1303
13041309 - `workspace_id: string`
13051310
13061311 - `BetaWebhookEnvironmentUpdatedEventData object`
13071312
1313 - `type: "environment.updated"`
1314
13081315 - `id: string`
13091316
13101317 ID of the environment that triggered the event.
13111318
13121319 - `organization_id: string`
13131320
1314 - `type: "environment.updated"`
1315
13161321 - `workspace_id: string`
13171322
13181323 - `BetaWebhookEnvironmentArchivedEventData object`
13191324
1325 - `type: "environment.archived"`
1326
13201327 - `id: string`
13211328
13221329 ID of the environment that triggered the event.
13231330
13241331 - `organization_id: string`
13251332
1326 - `type: "environment.archived"`
1327
13281333 - `workspace_id: string`
13291334
13301335 - `BetaWebhookEnvironmentDeletedEventData object`
13311336
1337 - `type: "environment.deleted"`
1338
13321339 - `id: string`
13331340
13341341 ID of the environment that triggered the event.
13351342
13361343 - `organization_id: string`
13371344
1338 - `type: "environment.deleted"`
1339
13401345 - `workspace_id: string`
13411346
13421347 - `BetaWebhookMemoryStoreCreatedEventData object`
13431348
1349 - `type: "memory_store.created"`
1350
13441351 - `id: string`
13451352
13461353 ID of the memory store that triggered the event.
13471354
13481355 - `organization_id: string`
13491356
1350 - `type: "memory_store.created"`
1351
13521357 - `workspace_id: string`
13531358
13541359 - `BetaWebhookMemoryStoreArchivedEventData object`
13551360
1361 - `type: "memory_store.archived"`
1362
13561363 - `id: string`
13571364
13581365 ID of the memory store that triggered the event.
13591366
13601367 - `organization_id: string`
13611368
1362 - `type: "memory_store.archived"`
1363
13641369 - `workspace_id: string`
13651370
13661371 - `BetaWebhookMemoryStoreDeletedEventData object`
13671372
1373 - `type: "memory_store.deleted"`
1374
13681375 - `id: string`
13691376
13701377 ID of the memory store that triggered the event.
13711378
13721379 - `organization_id: string`
13731380
1374 - `type: "memory_store.deleted"`
1375
13761381 - `workspace_id: string`
13771382
13781383 - `BetaWebhookSessionBudgetReachedEventData object`
13791384
1385 - `type: "session.budget_reached"`
1386
13801387 - `id: string`
13811388
13821389 ID of the session that triggered the event.
13831390
13841391 - `organization_id: string`
13851392
1386 - `type: "session.budget_reached"`
1387
13881393 - `workspace_id: string`
13891394
13901395### Beta Webhook Memory Store Archived Event Data
13911396
13921397- `BetaWebhookMemoryStoreArchivedEventData object`
13931398
1399 - `type: "memory_store.archived"`
1400
13941401 - `id: string`
13951402
13961403 ID of the memory store that triggered the event.
13971404
13981405 - `organization_id: string`
13991406
1400 - `type: "memory_store.archived"`
1401
14021407 - `workspace_id: string`
14031408
14041409### Beta Webhook Memory Store Created Event Data
14051410
14061411- `BetaWebhookMemoryStoreCreatedEventData object`
14071412
1413 - `type: "memory_store.created"`
1414
14081415 - `id: string`
14091416
14101417 ID of the memory store that triggered the event.
14111418
14121419 - `organization_id: string`
14131420
1414 - `type: "memory_store.created"`
1415
14161421 - `workspace_id: string`
14171422
14181423### Beta Webhook Memory Store Deleted Event Data
14191424
14201425- `BetaWebhookMemoryStoreDeletedEventData object`
14211426
1427 - `type: "memory_store.deleted"`
1428
14221429 - `id: string`
14231430
14241431 ID of the memory store that triggered the event.
14251432
14261433 - `organization_id: string`
14271434
1428 - `type: "memory_store.deleted"`
1429
14301435 - `workspace_id: string`
14311436
14321437### Beta Webhook Session Archived Event Data
14331438
14341439- `BetaWebhookSessionArchivedEventData object`
14351440
1441 - `type: "session.archived"`
1442
14361443 - `id: string`
14371444
14381445 ID of the session that triggered the event.
14391446
14401447 - `organization_id: string`
14411448
1442 - `type: "session.archived"`
1443
14441449 - `workspace_id: string`
14451450
14461451### Beta Webhook Session Budget Reached Event Data
14471452
14481453- `BetaWebhookSessionBudgetReachedEventData object`
14491454
1455 - `type: "session.budget_reached"`
1456
14501457 - `id: string`
14511458
14521459 ID of the session that triggered the event.
14531460
14541461 - `organization_id: string`
14551462
1456 - `type: "session.budget_reached"`
1457
14581463 - `workspace_id: string`
14591464
14601465### Beta Webhook Session Created Event Data
14611466
14621467- `BetaWebhookSessionCreatedEventData object`
14631468
1469 - `type: "session.created"`
1470
14641471 - `id: string`
14651472
14661473 ID of the session that triggered the event.
14671474
14681475 - `organization_id: string`
14691476
1470 - `type: "session.created"`
1471
14721477 - `workspace_id: string`
14731478
14741479### Beta Webhook Session Deleted Event Data
14751480
14761481- `BetaWebhookSessionDeletedEventData object`
14771482
1483 - `type: "session.deleted"`
1484
14781485 - `id: string`
14791486
14801487 ID of the session that triggered the event.
14811488
14821489 - `organization_id: string`
14831490
1484 - `type: "session.deleted"`
1485
14861491 - `workspace_id: string`
14871492
14881493### Beta Webhook Session Idled Event Data
14891494
14901495- `BetaWebhookSessionIdledEventData object`
14911496
1497 - `type: "session.idled"`
1498
14921499 - `id: string`
14931500
14941501 ID of the session that triggered the event.
14951502
14961503 - `organization_id: string`
14971504
1498 - `type: "session.idled"`
1499
15001505 - `workspace_id: string`
15011506
15021507### Beta Webhook Session Outcome Evaluation Ended Event Data
15031508
15041509- `BetaWebhookSessionOutcomeEvaluationEndedEventData object`
15051510
1511 - `type: "session.outcome_evaluation_ended"`
1512
15061513 - `id: string`
15071514
15081515 ID of the session that triggered the event.
15091516
15101517 - `organization_id: string`
15111518
1512 - `type: "session.outcome_evaluation_ended"`
1513
15141519 - `workspace_id: string`
15151520
15161521### Beta Webhook Session Pending Event Data
15171522
15181523- `BetaWebhookSessionPendingEventData object`
15191524
1525 - `type: "session.pending"`
1526
15201527 - `id: string`
15211528
15221529 ID of the session that triggered the event.
15231530
15241531 - `organization_id: string`
15251532
1526 - `type: "session.pending"`
1527
15281533 - `workspace_id: string`
15291534
15301535### Beta Webhook Session Requires Action Event Data
15311536
15321537- `BetaWebhookSessionRequiresActionEventData object`
15331538
1539 - `type: "session.requires_action"`
1540
15341541 - `id: string`
15351542
15361543 ID of the session that triggered the event.
15371544
15381545 - `organization_id: string`
15391546
1540 - `type: "session.requires_action"`
1541
15421547 - `workspace_id: string`
15431548
15441549### Beta Webhook Session Running Event Data
15451550
15461551- `BetaWebhookSessionRunningEventData object`
15471552
1553 - `type: "session.running"`
1554
15481555 - `id: string`
15491556
15501557 ID of the session that triggered the event.
15511558
15521559 - `organization_id: string`
15531560
1554 - `type: "session.running"`
1555
15561561 - `workspace_id: string`
15571562
15581563### Beta Webhook Session Status Idled Event Data
15591564
15601565- `BetaWebhookSessionStatusIdledEventData object`
15611566
1567 - `type: "session.status_idled"`
1568
15621569 - `id: string`
15631570
15641571 ID of the session that triggered the event.
15651572
15661573 - `organization_id: string`
15671574
1568 - `type: "session.status_idled"`
1569
15701575 - `workspace_id: string`
15711576
15721577### Beta Webhook Session Status Rescheduled Event Data
15731578
15741579- `BetaWebhookSessionStatusRescheduledEventData object`
15751580
1581 - `type: "session.status_rescheduled"`
1582
15761583 - `id: string`
15771584
15781585 ID of the session that triggered the event.
15791586
15801587 - `organization_id: string`
15811588
1582 - `type: "session.status_rescheduled"`
1583
15841589 - `workspace_id: string`
15851590
15861591### Beta Webhook Session Status Run Started Event Data
15871592
15881593- `BetaWebhookSessionStatusRunStartedEventData object`
15891594
1595 - `type: "session.status_run_started"`
1596
15901597 - `id: string`
15911598
15921599 ID of the session that triggered the event.
15931600
15941601 - `organization_id: string`
15951602
1596 - `type: "session.status_run_started"`
1597
15981603 - `workspace_id: string`
15991604
16001605### Beta Webhook Session Status Terminated Event Data
16011606
16021607- `BetaWebhookSessionStatusTerminatedEventData object`
16031608
1609 - `type: "session.status_terminated"`
1610
16041611 - `id: string`
16051612
16061613 ID of the session that triggered the event.
16071614
16081615 - `organization_id: string`
16091616
1610 - `type: "session.status_terminated"`
1611
16121617 - `workspace_id: string`
16131618
16141619### Beta Webhook Session Thread Created Event Data
16151620
16161621- `BetaWebhookSessionThreadCreatedEventData object`
16171622
1623 - `type: "session.thread_created"`
1624
16181625 - `id: string`
16191626
16201627 ID of the session that triggered the event.
from line 1632
16251632
16261633 ID of the session thread this event refers to.
16271634
1628 - `type: "session.thread_created"`
1629
16301635 - `workspace_id: string`
16311636
16321637### Beta Webhook Session Thread Idled Event Data
16331638
16341639- `BetaWebhookSessionThreadIdledEventData object`
16351640
1641 - `type: "session.thread_idled"`
1642
16361643 - `id: string`
16371644
16381645 ID of the session that triggered the event.
from line 1650
16431650
16441651 ID of the session thread this event refers to.
16451652
1646 - `type: "session.thread_idled"`
1647
16481653 - `workspace_id: string`
16491654
16501655### Beta Webhook Session Thread Terminated Event Data
16511656
16521657- `BetaWebhookSessionThreadTerminatedEventData object`
16531658
1659 - `type: "session.thread_terminated"`
1660
16541661 - `id: string`
16551662
16561663 ID of the session that triggered the event.
from line 1668
16611668
16621669 ID of the session thread this event refers to.
16631670
1664 - `type: "session.thread_terminated"`
1665
16661671 - `workspace_id: string`
16671672
16681673### Beta Webhook Session Updated Event Data
16691674
16701675- `BetaWebhookSessionUpdatedEventData object`
16711676
1677 - `type: "session.updated"`
1678
16721679 - `id: string`
16731680
16741681 ID of the session that triggered the event.
16751682
16761683 - `organization_id: string`
16771684
1678 - `type: "session.updated"`
1679
16801685 - `workspace_id: string`
16811686
16821687### Beta Webhook Vault Archived Event Data
16831688
16841689- `BetaWebhookVaultArchivedEventData object`
16851690
1691 - `type: "vault.archived"`
1692
16861693 - `id: string`
16871694
16881695 ID of the vault that triggered the event.
16891696
16901697 - `organization_id: string`
16911698
1692 - `type: "vault.archived"`
1693
16941699 - `workspace_id: string`
16951700
16961701### Beta Webhook Vault Created Event Data
16971702
16981703- `BetaWebhookVaultCreatedEventData object`
16991704
1705 - `type: "vault.created"`
1706
17001707 - `id: string`
17011708
17021709 ID of the vault that triggered the event.
17031710
17041711 - `organization_id: string`
17051712
1706 - `type: "vault.created"`
1707
17081713 - `workspace_id: string`
17091714
17101715### Beta Webhook Vault Credential Archived Event Data
17111716
17121717- `BetaWebhookVaultCredentialArchivedEventData object`
17131718
1719 - `type: "vault_credential.archived"`
1720
17141721 - `id: string`
17151722
17161723 ID of the vault credential that triggered the event.
17171724
17181725 - `organization_id: string`
17191726
1720 - `type: "vault_credential.archived"`
1721
17221727 - `vault_id: string`
17231728
17241729 ID of the vault that owns this credential.
from line 1734
17291734
17301735- `BetaWebhookVaultCredentialCreatedEventData object`
17311736
1737 - `type: "vault_credential.created"`
1738
17321739 - `id: string`
17331740
17341741 ID of the vault credential that triggered the event.
17351742
17361743 - `organization_id: string`
17371744
1738 - `type: "vault_credential.created"`
1739
17401745 - `vault_id: string`
17411746
17421747 ID of the vault that owns this credential.
from line 1752
17471752
17481753- `BetaWebhookVaultCredentialDeletedEventData object`
17491754
1755 - `type: "vault_credential.deleted"`
1756
17501757 - `id: string`
17511758
17521759 ID of the vault credential that triggered the event.
17531760
17541761 - `organization_id: string`
17551762
1756 - `type: "vault_credential.deleted"`
1757
17581763 - `vault_id: string`
17591764
17601765 ID of the vault that owns this credential.
from line 1770
17651770
17661771- `BetaWebhookVaultCredentialRefreshFailedEventData object`
17671772
1773 - `type: "vault_credential.refresh_failed"`
1774
17681775 - `id: string`
17691776
17701777 ID of the vault credential that triggered the event.
17711778
17721779 - `organization_id: string`
17731780
1774 - `type: "vault_credential.refresh_failed"`
1775
17761781 - `vault_id: string`
17771782
17781783 ID of the vault that owns this credential.
from line 1788
17831788
17841789- `BetaWebhookVaultDeletedEventData object`
17851790
1791 - `type: "vault.deleted"`
1792
17861793 - `id: string`
17871794
17881795 ID of the vault that triggered the event.
17891796
17901797 - `organization_id: string`
17911798
1792 - `type: "vault.deleted"`
1793
1794 - `workspace_id: string`
1799 - `workspace_id: string`
17951800
api/completions Changed · +26 / -17 lines
from line 1
1---
2title: Completions
3url: https://platform.claude.com/docs/en/api/completions
4---
5
16# Completions
27
38## Create a Text Completion
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120### Body parameters
112121
113122- `max_tokens_to_sample: number`
from line 297
288297
289298- `Completion object`
290299
300 - `type: "completion"`
301
302 Object type.
303
304 For Text Completions, this is always `"completion"`.
305
306 default: completion
307
291308 - `id: string`
292309
293310 Unique object identifier.
from line 406
389406 * `"stop_sequence"`: we reached a stop sequence — either provided by you via the `stop_sequences` parameter, or a stop sequence built into the model
390407 * `"max_tokens"`: we exceeded `max_tokens_to_sample` or the model's maximum
391408
392 - `type: "completion"`
393
394 Object type.
395
396 For Text Completions, this is always `"completion"`.
397
398 default: completion
399
400409### Example
401410
402411```bash
from line 442
433442
434443- `Completion object`
435444
445 - `type: "completion"`
446
447 Object type.
448
449 For Text Completions, this is always `"completion"`.
450
451 default: completion
452
436453 - `id: string`
437454
438455 Unique object identifier.
from line 550
533550
534551 * `"stop_sequence"`: we reached a stop sequence — either provided by you via the `stop_sequences` parameter, or a stop sequence built into the model
535552 * `"max_tokens"`: we exceeded `max_tokens_to_sample` or the model's maximum
536
537 - `type: "completion"`
538
539 Object type.
540
541 For Text Completions, this is always `"completion"`.
542
543 default: completion
544553
api/completions/create Changed · +18 / -9 lines
from line 1
1---
2title: Create a Text Completion
3url: https://platform.claude.com/docs/en/api/completions/create
4---
5
16# Create a Text Completion
27
38**POST** `/v1/complete`
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## Body parameters
110119
111120- `max_tokens_to_sample: number`
from line 295
286295
287296- `Completion object`
288297
298 - `type: "completion"`
299
300 Object type.
301
302 For Text Completions, this is always `"completion"`.
303
304 default: completion
305
289306 - `id: string`
290307
291308 Unique object identifier.
from line 403
386403
387404 * `"stop_sequence"`: we reached a stop sequence — either provided by you via the `stop_sequences` parameter, or a stop sequence built into the model
388405 * `"max_tokens"`: we exceeded `max_tokens_to_sample` or the model's maximum
389
390 - `type: "completion"`
391
392 Object type.
393
394 For Text Completions, this is always `"completion"`.
395
396 default: completion
397406
398407## Example
399408
api/compliance Changed · +40415 / -36588 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/compliance/activities Changed · +79779 / -72764 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/compliance/activities/list Changed · +39946 / -36398 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/compliance/apps Changed · +317 / -127 lines
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Apps
3url: https://platform.claude.com/docs/en/api/compliance/apps
4---
5
16# Apps
27
38## Apps › Chats
from line 118
113118
114119#### Headers
115120
121- `"anthropic-version": optional string`
122
123 The version of the Claude API you want to use.
124
125 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
126
116127- `"x-api-key": optional string`
117128
118129#### Returns
from line 176
165176
166177 - `user: object or null`
167178
168 User information for compliance responses.
179 The user who created the chat.
180
181 Null when the API key is restricted to one organization and the creator
182 is no longer a member of it (for example, after they were removed from
183 it).
184
185 A key for the whole parent organization returns the creator's `id`
186 and current `email_address` for every chat; on the list endpoint, pass
187 `organization_ids[]` to keep the results to one organization. For the
188 email address the creator had when the chat was created, query
189 `GET /v1/compliance/activities` with `activity_types[]=claude_chat_created`
190 and a `created_at` window around the chat's `created_at`, find the event
191 whose `claude_chat_id` matches this chat's `id`, and read
192 `actor.email_address`. These events exist only for chats created after
193 compliance logging was enabled for the organization.
169194
170195 - `id: string`
171196
from line 267
242267
243268#### Headers
244269
270- `"anthropic-version": optional string`
271
272 The version of the Claude API you want to use.
273
274 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
275
245276- `"x-api-key": optional string`
246277
247278#### Returns
248279
280- `type: optional "claude_chat_deleted"`
281
282 Constant string confirming deletion
283
284 default: claude_chat_deleted
285
249286- `id: string`
250287
251288 The ID of the Claude chat that was deleted
252
253- `type: optional "claude_chat_deleted"`
254
255 Constant string confirming deletion
256
257 default: claude_chat_deleted
258289
259290#### Example
260291
from line 410
379410
380411#### Headers
381412
413- `"anthropic-version": optional string`
414
415 The version of the Claude API you want to use.
416
417 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
418
382419- `"x-api-key": optional string`
383420
384421#### Returns
from line 460
423460
424461 Text content block.
425462
463 - `type: "text"`
464
465 default: text
466
426467 - `text: string`
427468
428469 Text content from human or assistant
from line 480
439480
440481 default: false
441482
442 - `type: "text"`
443
444 default: text
445
446483 - `ToolUse object`
447484
448485 Tool invocation requested by the assistant.
449486
487 - `type: "tool_use"`
488
489 default: tool_use
490
450491 - `id: string or null`
451492
452493 Tool-use ID, e.g. 'toolu_01AbC...'
from line 514
473514
474515 default: false
475516
476 - `type: "tool_use"`
477
478 default: tool_use
479
480517 - `ToolResult object`
481518
482519 Result returned by a tool invocation.
483520
521 - `type: "tool_result"`
522
523 default: tool_result
524
484525 - `content: array of object`
485526
486527 Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted.
487528
529 - `type: "text"`
530
531 default: text
532
488533 - `text: string`
489534
490535 Text returned by the tool
491536
492 - `type: "text"`
493
494 default: text
495
496537 - `integration_name: string or null`
497538
498539 Name of the integration that provides this tool, when applicable
from line 560
519560
520561 default: false
521562
522 - `type: "tool_result"`
523
524 default: tool_result
525
526563 - `created_at: string`
527564
528565 Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block
from line 682
645682
646683- `user: object or null`
647684
648 User information for compliance responses.
685 The user who created the chat.
686
687 Null when the API key is restricted to one organization and the creator
688 is no longer a member of it (for example, after they were removed from
689 it).
690
691 A key for the whole parent organization returns the creator's `id`
692 and current `email_address` for every chat; on the list endpoint, pass
693 `organization_ids[]` to keep the results to one organization. For the
694 email address the creator had when the chat was created, query
695 `GET /v1/compliance/activities` with `activity_types[]=claude_chat_created`
696 and a `created_at` window around the chat's `created_at`, find the event
697 whose `claude_chat_id` matches this chat's `id`, and read
698 `actor.email_address`. These events exist only for chats created after
699 compliance logging was enabled for the organization.
649700
650701 - `id: string`
651702
from line 802
751802
752803#### Headers
753804
805- `"anthropic-version": optional string`
806
807 The version of the Claude API you want to use.
808
809 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
810
754811- `"x-api-key": optional string`
755812
756813#### Returns
from line 887
830887
831888#### Headers
832889
890- `"anthropic-version": optional string`
891
892 The version of the Claude API you want to use.
893
894 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
895
833896- `"x-api-key": optional string`
834897
835898#### Returns
836899
900- `type: optional "claude_file_deleted"`
901
902 Constant string confirming deletion
903
904 default: claude_file_deleted
905
837906- `id: string`
838907
839908 The ID of the file that was deleted
840
841- `type: optional "claude_file_deleted"`
842
843 Constant string confirming deletion
844
845 default: claude_file_deleted
846909
847910#### Example
848911
from line 938
875938
876939#### Headers
877940
941- `"anthropic-version": optional string`
942
943 The version of the Claude API you want to use.
944
945 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
946
878947- `"x-api-key": optional string`
879948
880949#### Example
from line 970
901970 The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
902971
903972#### Headers
973
974- `"anthropic-version": optional string`
975
976 The version of the Claude API you want to use.
977
978 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
904979
905980- `"x-api-key": optional string`
906981
from line 1046
9711046
9721047#### Headers
9731048
1049- `"anthropic-version": optional string`
1050
1051 The version of the Claude API you want to use.
1052
1053 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1054
9741055- `"x-api-key": optional string`
9751056
9761057#### Example
from line 1143
10621143 Filter by user IDs. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
10631144
10641145#### Headers
1146
1147- `"anthropic-version": optional string`
1148
1149 The version of the Claude API you want to use.
1150
1151 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
10651152
10661153- `"x-api-key": optional string`
10671154
from line 1267
11801267
11811268#### Headers
11821269
1270- `"anthropic-version": optional string`
1271
1272 The version of the Claude API you want to use.
1273
1274 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1275
11831276- `"x-api-key": optional string`
11841277
11851278#### Returns
from line 1402
13091402
13101403#### Headers
13111404
1405- `"anthropic-version": optional string`
1406
1407 The version of the Claude API you want to use.
1408
1409 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1410
13121411- `"x-api-key": optional string`
13131412
13141413#### Returns
13151414
1415- `type: optional "claude_project_deleted"`
1416
1417 Constant string confirming deletion.
1418
1419 default: claude_project_deleted
1420
13161421- `id: string`
13171422
13181423 The ID of the Claude project that was deleted
1319
1320- `type: optional "claude_project_deleted"`
1321
1322 Constant string confirming deletion.
1323
1324 default: claude_project_deleted
13251424
13261425#### Example
13271426
from line 1476
13771476
13781477#### Headers
13791478
1479- `"anthropic-version": optional string`
1480
1481 The version of the Claude API you want to use.
1482
1483 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1484
13801485- `"x-api-key": optional string`
13811486
13821487#### Returns
from line 1494
13891494
13901495 File attachment reference for compliance responses.
13911496
1497 - `type: "project_file"`
1498
1499 Discriminator marking this as a binary file
1500
1501 default: project_file
1502
13921503 - `id: string`
13931504
13941505 File identifier (e.g., 'claude_file_abcd')
from line 1526
14151526
14161527 Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file `/metadata` endpoint for the authoritative value.
14171528
1418 - `type: "project_file"`
1419
1420 Discriminator marking this as a binary file
1421
1422 default: project_file
1423
14241529 - `ComplianceProjectDocReference object`
14251530
14261531 Project document attachment reference for compliance responses.
14271532
1533 - `type: "project_doc"`
1534
1535 Discriminator marking this as a plain text document
1536
1537 default: project_doc
1538
14281539 - `id: string`
14291540
14301541 Project document identifier (e.g., 'claude_proj_doc_abcd')
from line 1555
14441555 MIME type of the project document, always set to plain text
14451556
14461557 default: text/plain
1447
1448 - `type: "project_doc"`
1449
1450 Discriminator marking this as a plain text document
1451
1452 default: project_doc
14531558
14541559 - `updated_at: string or null`
14551560
from line 1630
15251630
15261631#### Headers
15271632
1633- `"anthropic-version": optional string`
1634
1635 The version of the Claude API you want to use.
1636
1637 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1638
15281639- `"x-api-key": optional string`
15291640
15301641#### Returns
from line 1648
15371648
15381649 An individual user granted a role on a project.
15391650
1651 - `type: "user"`
1652
1653 Discriminator marking this as an individual user collaborator
1654
1655 default: user
1656
15401657 - `granted_at: string`
15411658
15421659 When this collaborator was granted access (RFC 3339 format)
from line 1672
15551672
15561673 - `"viewer"`
15571674
1558 - `type: "user"`
1559
1560 Discriminator marking this as an individual user collaborator
1561
1562 default: user
1563
15641675 - `user_id: string or null`
15651676
15661677 Identifier of the user granted access (tagged ID), or null if their account has since been deleted
from line 1680
15691680
15701681 An RBAC group granted a role on a project.
15711682
1683 - `type: "group"`
1684
1685 Discriminator marking this as a group collaborator
1686
1687 default: group
1688
15721689 - `granted_at: string`
15731690
15741691 When this collaborator was granted access (RFC 3339 format)
from line 1708
15911708
15921709 - `"viewer"`
15931710
1594 - `type: "group"`
1595
1596 Discriminator marking this as a group collaborator
1597
1598 default: group
1599
16001711 - `ComplianceProjectOrganizationCollaborator object`
16011712
16021713 An entire organization granted a role on a project.
16031714
1715 - `type: "organization"`
1716
1717 Discriminator marking this as an organization-wide grant
1718
1719 default: organization
1720
16041721 - `granted_at: string`
16051722
16061723 When this collaborator was granted access (RFC 3339 format)
from line 1740
16231740
16241741 - `"viewer"`
16251742
1626 - `type: "organization"`
1627
1628 Discriminator marking this as an organization-wide grant
1629
1630 default: organization
1631
16321743 - `ComplianceProjectOrganizationRoleCollaborator object`
16331744
16341745 All holders of an organization-level role granted a role on a project.
16351746
1747 - `type: "organization_role"`
1748
1749 Discriminator marking this as a grant to all organization members holding a specific org-level role
1750
1751 default: organization_role
1752
16361753 - `granted_at: string`
16371754
16381755 When this collaborator was granted access (RFC 3339 format)
from line 1771
16541771 - `"owner"`
16551772
16561773 - `"viewer"`
1657
1658 - `type: "organization_role"`
1659
1660 Discriminator marking this as a grant to all organization members holding a specific org-level role
1661
1662 default: organization_role
16631774
16641775- `has_more: boolean`
16651776
from line 1820
17091820
17101821#### Headers
17111822
1823- `"anthropic-version": optional string`
1824
1825 The version of the Claude API you want to use.
1826
1827 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1828
17121829- `"x-api-key": optional string`
17131830
17141831#### Returns
from line 1904
17871904 The document ID (tagged ID, e.g., claude_proj_doc_abc123)
17881905
17891906#### Headers
1907
1908- `"anthropic-version": optional string`
1909
1910 The version of the Claude API you want to use.
1911
1912 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
17901913
17911914- `"x-api-key": optional string`
17921915
from line 2004
18812004
18822005#### Headers
18832006
2007- `"anthropic-version": optional string`
2008
2009 The version of the Claude API you want to use.
2010
2011 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2012
18842013- `"x-api-key": optional string`
18852014
18862015#### Returns
18872016
2017- `type: "claude_project_document_deleted"`
2018
2019 Constant string confirming deletion.
2020
2021 default: claude_project_document_deleted
2022
18882023- `id: string`
18892024
18902025 The ID of the project document that was deleted
1891
1892- `type: "claude_project_document_deleted"`
1893
1894 Constant string confirming deletion.
1895
1896 default: claude_project_document_deleted
18972026
18982027#### Example
18992028
from line 2061
19322061 The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)
19332062
19342063#### Headers
2064
2065- `"anthropic-version": optional string`
2066
2067 The version of the Claude API you want to use.
2068
2069 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
19352070
19362071- `"x-api-key": optional string`
19372072
from line 2144
20092144
20102145#### Headers
20112146
2147- `"anthropic-version": optional string`
2148
2149 The version of the Claude API you want to use.
2150
2151 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2152
20122153- `"x-api-key": optional string`
20132154
20142155#### Example
from line 2206
20652206
20662207#### Headers
20672208
2209- `"anthropic-version": optional string`
2210
2211 The version of the Claude API you want to use.
2212
2213 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2214
20682215- `"x-api-key": optional string`
20692216
20702217#### Returns
from line 2220
20732220
20742221 Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order. `updated_at` never participates in the ordering; the `updated_at.gte` query parameter filters on it without changing the order or the pagination cursor.
20752222
2223 - `type: "compliance_local_session"`
2224
2225 default: compliance_local_session
2226
20762227 - `id: string`
20772228
20782229 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 2242
20912242
20922243 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.
20932244
2094 - `type: "compliance_local_session"`
2095
2096 default: compliance_local_session
2245 - `truncated: boolean`
2246
2247 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
2248
2249 default: false
20972250
20982251 - `updated_at: string`
20992252
from line 2320
21672320
21682321#### Headers
21692322
2323- `"anthropic-version": optional string`
2324
2325 The version of the Claude API you want to use.
2326
2327 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2328
21702329- `"x-api-key": optional string`
21712330
21722331#### Returns
21732332
2333- `type: "compliance_local_session"`
2334
2335 default: compliance_local_session
2336
21742337- `id: string`
21752338
21762339 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 2352
21892352
21902353 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.
21912354
2192- `type: "compliance_local_session"`
2193
2194 default: compliance_local_session
2355- `truncated: boolean`
2356
2357 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
2358
2359 default: false
21952360
21962361- `updated_at: string`
21972362
from line 2461
22962461
22972462#### Headers
22982463
2464- `"anthropic-version": optional string`
2465
2466 The version of the Claude API you want to use.
2467
2468 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2469
22992470- `"x-api-key": optional string`
23002471
23012472#### Returns
from line 2475
23042475
23052476 Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
23062477
2478 - `type: "compliance_local_session_message"`
2479
2480 default: compliance_local_session_message
2481
23072482 - `id: string`
23082483
23092484 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 2491
23162491
23172492 Text content block.
23182493
2494 - `type: "text"`
2495
2496 default: text
2497
23192498 - `text: string`
23202499
23212500 Text content from the user or the assistant
from line 2505
23262505
23272506 default: false
23282507
2329 - `type: "text"`
2330
2331 default: text
2332
23332508 - `ToolUse object`
23342509
23352510 Tool invocation requested by the assistant.
23362511
2512 - `type: "tool_use"`
2513
2514 default: tool_use
2515
23372516 - `id: string or null`
23382517
23392518 Tool-use ID, e.g. 'toolu_01AbC...'
from line 2531
23522531
23532532 default: false
23542533
2355 - `type: "tool_use"`
2356
2357 default: tool_use
2358
23592534 - `ToolResult object`
23602535
23612536 Result returned by a tool invocation.
23622537
2538 - `type: "tool_result"`
2539
2540 default: tool_result
2541
23632542 - `content: array of object`
23642543
23652544 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
23662545
2546 - `type: "text"`
2547
2548 default: text
2549
23672550 - `text: string`
23682551
23692552 Text returned by the tool
23702553
2371 - `type: "text"`
2372
2373 default: text
2374
23752554 - `is_error: boolean`
23762555
23772556 True when the tool reported an error
from line 2569
23902569
23912570 default: false
23922571
2393 - `type: "tool_result"`
2394
2395 default: tool_result
2396
23972572 - `created_at: string`
23982573
23992574 When the message was recorded (RFC 3339, UTC)
from line 2587
24122587
24132588 The turn's content cannot be returned; `content` is empty.
24142589
2590 - `type: "content_unavailable"`
2591
2592 default: content_unavailable
2593
24152594 - `reason: string`
24162595
24172596 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
2418
2419 - `type: "content_unavailable"`
2420
2421 default: content_unavailable
24222597
24232598 - `ClientAsserted object`
24242599
from line 2631
24562631
24572632 - `"user"`
24582633
2459 - `type: "compliance_local_session_message"`
2460
2461 default: compliance_local_session_message
2462
24632634- `next_page: string or null`
24642635
24652636 Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
from line 2639
24682639
24692640 The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
24702641
2642 - `type: "compliance_local_session"`
2643
2644 default: compliance_local_session
2645
24712646 - `id: string`
24722647
24732648 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 2661
24862661
24872662 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.
24882663
2489 - `type: "compliance_local_session"`
2490
2491 default: compliance_local_session
2664 - `truncated: boolean`
2665
2666 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
2667
2668 default: false
24922669
24932670 - `updated_at: string`
24942671
from line 2726
25492726 "created_at": "2025-03-12T18:22:41.123456Z",
25502727 "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
25512728 "product_surface": "cowork",
2729 "truncated": true,
25522730 "type": "compliance_local_session",
25532731 "updated_at": "2025-03-12T18:22:41.123456Z",
25542732 "user": {
from line 2813
26352813 maxItems: 10
26362814
26372815#### Headers
2816
2817- `"anthropic-version": optional string`
2818
2819 The version of the Claude API you want to use.
2820
2821 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
26382822
26392823- `"x-api-key": optional string`
26402824
from line 2989
28052989
28062990#### Headers
28072991
2992- `"anthropic-version": optional string`
2993
2994 The version of the Claude API you want to use.
2995
2996 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2997
28082998- `"x-api-key": optional string`
28092999
28103000#### Returns
from line 3015
28253015
28263016 Text content block.
28273017
3018 - `type: "text"`
3019
3020 default: text
3021
28283022 - `text: string`
28293023
28303024 Text content from the user or the assistant
from line 3029
28353029
28363030 default: false
28373031
2838 - `type: "text"`
2839
2840 default: text
2841
28423032 - `ToolUse object`
28433033
28443034 Tool invocation requested by the assistant.
28453035
3036 - `type: "tool_use"`
3037
3038 default: tool_use
3039
28463040 - `id: string or null`
28473041
28483042 Tool-use ID, e.g. 'toolu_01AbC...'
from line 3055
28613055
28623056 default: false
28633057
2864 - `type: "tool_use"`
2865
2866 default: tool_use
2867
28683058 - `ToolResult object`
28693059
28703060 Result returned by a tool invocation.
28713061
3062 - `type: "tool_result"`
3063
3064 default: tool_result
3065
28723066 - `content: array of object`
28733067
28743068 Text content returned by the tool. Non-text item types are omitted.
28753069
3070 - `type: "text"`
3071
3072 default: text
3073
28763074 - `text: string`
28773075
28783076 Text returned by the tool
28793077
2880 - `type: "text"`
2881
2882 default: text
2883
28843078 - `is_error: boolean`
28853079
28863080 True when the tool reported an error
from line 3092
28983092 True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
28993093
29003094 default: false
2901
2902 - `type: "tool_result"`
2903
2904 default: tool_result
29053095
29063096 - `content_unavailable: boolean`
29073097
29083098
api/compliance/apps/artifacts Changed · +17 / -0 lines
from line 1
1---
2title: Artifacts
3url: https://platform.claude.com/docs/en/api/compliance/apps/artifacts
4---
5
16# Artifacts
27
38## Get artifact metadata
from line 24
1924
2025### Headers
2126
27- `"anthropic-version": optional string`
28
29 The version of the Claude API you want to use.
30
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
32
2233- `"x-api-key": optional string`
2334
2435### Returns
from line 105
94105 The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)
95106
96107### Headers
108
109- `"anthropic-version": optional string`
110
111 The version of the Claude API you want to use.
112
113 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
97114
98115- `"x-api-key": optional string`
99116
api/compliance/apps/artifacts/download Changed · +11 / -0 lines
from line 1
1---
2title: Download artifact content
3url: https://platform.claude.com/docs/en/api/compliance/apps/artifacts/download
4---
5
16# Download artifact content
27
38**GET** `/v1/compliance/apps/artifacts/{artifact_version_id}/content`
from line 18
1318 The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)
1419
1520## Headers
21
22- `"anthropic-version": optional string`
23
24 The version of the Claude API you want to use.
25
26 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1627
1728- `"x-api-key": optional string`
1829