One read of Claude Developer Platformapi-20261020T020708Z
124 pages moved out of 785 read.
Pages moved
124
significant first
Pages read
785
in this capture
Captured
02:07 UTC
Corpus hash
05505ffc3bb1
index-hash
What this read moved
26-50 of 124, page 2 of 5This capture is too large to show at once. Changes 26-50 of 124 are below, significant first; the rest are on the following screens.
api/beta/vaults/credentials/archive Changed · +9 / -7 lines
# Archive a Credential # Archive Credential
from line 1
11---
2title: Archive Credential
2title: Archive a Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/archive
44---
55
6# Archive Credential
6# Archive a Credential
77
88**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/archive`
99
10Archive Credential
10Archive a Credential
1111
1212## Path parameters
1313
from line 151
151151
152152 - `id: string`
153153
154 Unique identifier for the credential.
154 The unique ID of the credential (`vcrd_...`).
155155
156156 - `archived_at: string or null`
157157
from line 175
175175
176176 - `expires_at: optional string or null`
177177
178 A timestamp in RFC 3339 format
178 When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.
179179
180180 format: date-time
181181
from line 185
185185
186186 - `client_id: string`
187187
188 OAuth client ID.
188 The OAuth client ID used when refreshing the access token.
189189
190190 - `token_endpoint: string`
191191
from line 265
265265
266266 - `allowed_hosts: array of string`
267267
268 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.
268 The destination hosts of the outbound requests that the credential's secret is substituted into.
269
270 An entry matches the request host exactly. An entry such as `*.example.com` matches any subdomain of `example.com` but not `example.com` itself.
269271
270272 - `secret_name: string`
271273
api/beta/vaults/credentials/create Changed · +22 / -16 lines
# Create a Credential # Create Credential
from line 1
11---
2title: Create Credential
2title: Create a Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/create
44---
55
6# Create Credential
6# Create a Credential
77
88**POST** `/v1/vaults/{vault_id}/credentials`
99
10Create Credential
10Create a Credential
1111
1212## Path parameters
1313
from line 151
151151
152152 - `access_token: string`
153153
154 OAuth access token.
154 The OAuth access token to send to the MCP server.
155155
156156 minLength: 1, maxLength: 8192
157157
from line 163
163163
164164 - `expires_at: optional string or null`
165165
166 A timestamp in RFC 3339 format
166 When `access_token` expires, in RFC 3339.
167167
168 Must be in the future.
169
168170 format: date-time
169171
170172 - `refresh: optional BetaManagedAgentsMCPOAuthRefreshParams or null`
from line 175
173175
174176 - `client_id: string`
175177
176 OAuth client ID.
178 The OAuth client ID to use when refreshing the access token. It can't be changed after the credential is created.
177179
178180 minLength: 1, maxLength: 1024
179181
180182 - `refresh_token: string`
181183
182 OAuth refresh token.
184 The OAuth refresh token that the API uses to get a new access token when the current one expires.
183185
184186 minLength: 1, maxLength: 8192
185187
from line 207
205207
206208 - `client_secret: string`
207209
208 OAuth client secret.
210 The OAuth client secret, sent to `token_endpoint` with HTTP Basic authentication.
209211
210212 minLength: 1, maxLength: 512
211213
from line 219
217219
218220 - `client_secret: string`
219221
220 OAuth client secret.
222 The OAuth client secret, sent to `token_endpoint` in the POST body.
221223
222224 minLength: 1, maxLength: 512
223225
from line 243
241243
242244 - `token: string`
243245
244 Static bearer token value.
246 The static bearer token to send to the MCP server, such as an API key or personal access token.
245247
246248 minLength: 1, maxLength: 8192
247249
from line 277
275277
276278 - `allowed_hosts: array of string`
277279
278 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.
280 The destination hosts of the outbound requests that the credential's secret is substituted into.
279281
282 Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.` wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses aren't accepted. The list can have up to 16 entries.
283
280284 - `secret_name: string`
281285
282286 Name of the environment variable. Immutable after create.
from line 289
285289
286290 - `secret_value: string`
287291
288 Secret value. Write-only; never returned in responses.
292 The secret to substitute into the agent's outbound requests. It's write-only and never returned in responses.
289293
290294 minLength: 1, maxLength: 4096
291295
from line 325
321325
322326 - `id: string`
323327
324 Unique identifier for the credential.
328 The unique ID of the credential (`vcrd_...`).
325329
326330 - `archived_at: string or null`
327331
from line 349
345349
346350 - `expires_at: optional string or null`
347351
348 A timestamp in RFC 3339 format
352 When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.
349353
350354 format: date-time
351355
from line 359
355359
356360 - `client_id: string`
357361
358 OAuth client ID.
362 The OAuth client ID used when refreshing the access token.
359363
360364 - `token_endpoint: string`
361365
from line 439
435439
436440 - `allowed_hosts: array of string`
437441
438 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.
442 The destination hosts of the outbound requests that the credential's secret is substituted into.
443
444 An entry matches the request host exactly. An entry such as `*.example.com` matches any subdomain of `example.com` but not `example.com` itself.
439445
440446 - `secret_name: string`
441447
api/beta/vaults/credentials/delete Changed · +4 / -4 lines
# Delete a Credential # Delete Credential
from line 1
11---
2title: Delete Credential
2title: Delete a Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/delete
44---
55
6# Delete Credential
6# Delete a Credential
77
88**DELETE** `/v1/vaults/{vault_id}/credentials/{credential_id}`
99
10Delete Credential
10Delete a Credential
1111
1212## Path parameters
1313
from line 151
151151
152152 - `id: string`
153153
154 Unique identifier of the deleted credential.
154 The unique ID of the deleted credential (`vcrd_...`).
155155
156156## Example
157157
api/beta/vaults/credentials/list Changed · +9 / -7 lines
from line 19
1919
2020- `include_archived: optional boolean`
2121
22 Whether to include archived credentials in the results.
22 Whether to include archived credentials in the results. Defaults to `false`.
2323
2424- `limit: optional number`
2525
from line 29
2929
3030- `page: optional string`
3131
32 Opaque pagination token from a previous `list_credentials` response.
32 The `next_page` value from a previous [List Credentials](https://platform.claude.com/docs/en/api/beta/vaults/credentials/list?sdk_languages=http) response, to get the next page. Leave it out to get the first page.
3333
3434## Headers
3535
from line 157
157157
158158- `data: optional array of BetaManagedAgentsCredential`
159159
160 List of credentials.
160 The credentials on this page, newest first.
161161
162162 - `type: "vault_credential"`
163163
164164 - `id: string`
165165
166 Unique identifier for the credential.
166 The unique ID of the credential (`vcrd_...`).
167167
168168 - `archived_at: string or null`
169169
from line 187
187187
188188 - `expires_at: optional string or null`
189189
190 A timestamp in RFC 3339 format
190 When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.
191191
192192 format: date-time
193193
from line 197
197197
198198 - `client_id: string`
199199
200 OAuth client ID.
200 The OAuth client ID used when refreshing the access token.
201201
202202 - `token_endpoint: string`
203203
from line 277
277277
278278 - `allowed_hosts: array of string`
279279
280 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.
280 The destination hosts of the outbound requests that the credential's secret is substituted into.
281
282 An entry matches the request host exactly. An entry such as `*.example.com` matches any subdomain of `example.com` but not `example.com` itself.
281283
282284 - `secret_name: string`
283285
api/beta/vaults/credentials/mcp_oauth_validate Changed · +7 / -7 lines
# Validate an MCP OAuth Credential # Validate Credential
from line 1
11---
2title: Validate Credential
2title: Validate an MCP OAuth Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/mcp_oauth_validate
44---
55
6# Validate Credential
6# Validate an MCP OAuth Credential
77
88**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate`
99
10Validate Credential
10Validate an MCP OAuth Credential
1111
1212## Path parameters
1313
from line 159
159159
160160 - `mcp_probe: BetaManagedAgentsMCPProbe or null`
161161
162 Details of the failing MCP probe step. Null when the probe succeeded.
162 Details of the MCP probe step that failed, or `null` if the probe succeeded or there was no access token to test.
163163
164164 - `http_response: BetaManagedAgentsRefreshHTTPResponse or null`
165165
166 The captured HTTP error response. Null when no HTTP response was received (timeout, DNS, TLS).
166 The HTTP error response from the MCP server, or `null` if the MCP server didn't return one for the failing step, for example after a timeout or a DNS or TLS failure.
167167
168168 - `body: string`
169169
from line 225
225225
226226 - `"invalid"`
227227
228 The probe reached the MCP server and was rejected, and a refresh (if attempted) did not recover it.
228 The probe reached the MCP server and the server rejected the credential, or no access token is stored. A refresh, if one was tried, didn't recover it. Usually the end user needs to authorize again.
229229
230230 - `"unknown"`
231231
232 The probe could not determine validity — for example, a transport error or a successful refresh that was not re-probed.
232 The probe couldn't tell whether the credential works, for example because of a network error or because a refresh succeeded but the new access token wasn't tested. Validate the credential again to find out.
233233
234234 - `validated_at: string`
235235
api/beta/vaults/credentials/retrieve Changed · +9 / -7 lines
# Retrieve a Credential # Get Credential
from line 1
11---
2title: Get Credential
2title: Retrieve a Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/retrieve
44---
55
6# Get Credential
6# Retrieve a Credential
77
88**GET** `/v1/vaults/{vault_id}/credentials/{credential_id}`
99
10Get Credential
10Retrieve a Credential
1111
1212## Path parameters
1313
from line 151
151151
152152 - `id: string`
153153
154 Unique identifier for the credential.
154 The unique ID of the credential (`vcrd_...`).
155155
156156 - `archived_at: string or null`
157157
from line 175
175175
176176 - `expires_at: optional string or null`
177177
178 A timestamp in RFC 3339 format
178 When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.
179179
180180 format: date-time
181181
from line 185
185185
186186 - `client_id: string`
187187
188 OAuth client ID.
188 The OAuth client ID used when refreshing the access token.
189189
190190 - `token_endpoint: string`
191191
from line 265
265265
266266 - `allowed_hosts: array of string`
267267
268 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.
268 The destination hosts of the outbound requests that the credential's secret is substituted into.
269
270 An entry matches the request host exactly. An entry such as `*.example.com` matches any subdomain of `example.com` but not `example.com` itself.
269271
270272 - `secret_name: string`
271273
api/beta/vaults/credentials/update Changed · +30 / -18 lines
# Update a Credential # Update Credential
from line 1
11---
2title: Update Credential
2title: Update a Credential
33url: https://platform.claude.com/docs/en/api/beta/vaults/credentials/update
44---
55
6# Update Credential
6# Update a Credential
77
88**POST** `/v1/vaults/{vault_id}/credentials/{credential_id}`
99
10Update Credential
10Update a Credential
1111
1212## Path parameters
1313
from line 145
145145
146146- `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams`
147147
148 Updated authentication configuration. The `type` is immutable; the variant sent must match the stored credential's type.
148 New authentication settings for the credential. The `type` must match the credential's current type, which can't be changed.
149149
150150 - `BetaManagedAgentsMCPOAuthUpdateParams object`
151151
from line 155
155155
156156 - `access_token: optional string or null`
157157
158 Updated OAuth access token.
158 The new OAuth access token to replace the stored one.
159159
160160 minLength: 1, maxLength: 8192
161161
162162 - `expires_at: optional string or null`
163163
164 A timestamp in RFC 3339 format
164 When the credential's access token expires, in RFC 3339. Leave it out to keep the stored expiry.
165165
166 If you send a new `access_token`, send its `expires_at` too, or the new token keeps the old expiry.
167
168 Must be in the future.
169
166170 format: date-time
167171
168172 - `refresh: optional BetaManagedAgentsMCPOAuthRefreshUpdateParams or null`
from line 175
171175
172176 - `refresh_token: optional string or null`
173177
174 Updated OAuth refresh token.
178 The new OAuth refresh token to replace the stored one.
175179
176180 minLength: 1, maxLength: 8192
177181
178182 - `scope: optional string or null`
179183
180 Updated OAuth scope for the refresh request.
184 The new OAuth scope for refresh requests. Send an empty string to clear the stored scope.
181185
182186 maxLength: 8192
183187
from line 195
191195
192196 - `client_secret: optional string or null`
193197
194 Updated OAuth client secret.
198 A new OAuth client secret to replace the stored one.
195199
200 The credential must already use `client_secret_basic` or `client_secret_post`. It keeps its current `token_endpoint_auth` type, even if the `type` sent with this secret is the other one.
201
196202 minLength: 1, maxLength: 512
197203
198204 - `BetaManagedAgentsTokenEndpointAuthPostUpdateParam object`
from line 209
203209
204210 - `client_secret: optional string or null`
205211
206 Updated OAuth client secret.
212 A new OAuth client secret to replace the stored one.
207213
214 The credential must already use `client_secret_basic` or `client_secret_post`. It keeps its current `token_endpoint_auth` type, even if the `type` sent with this secret is the other one.
215
208216 minLength: 1, maxLength: 512
209217
210218 - `BetaManagedAgentsStaticBearerUpdateParams object`
from line 223
215223
216224 - `token: optional string or null`
217225
218 Updated static bearer token value.
226 The new static bearer token to replace the stored one.
219227
220228 minLength: 1, maxLength: 8192
221229
from line 247
239247
240248 - `networking: optional BetaManagedAgentsCredentialNetworkingParams or null`
241249
242 Updated networking scope. Full replacement.
250 The new networking scope, which replaces the stored one as a whole.
243251
244252 - `BetaManagedAgentsUnrestrictedCredentialNetworkingParams object`
245253
from line 263
255263
256264 - `allowed_hosts: array of string`
257265
258 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.
266 The destination hosts of the outbound requests that the credential's secret is substituted into.
259267
268 Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.` wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses aren't accepted. The list can have up to 16 entries.
269
260270 - `secret_value: optional string or null`
261271
262 Updated secret value.
272 The new secret value to replace the stored one.
263273
264274 minLength: 1, maxLength: 4096
265275
from line 293
283293
284294 - `id: string`
285295
286 Unique identifier for the credential.
296 The unique ID of the credential (`vcrd_...`).
287297
288298 - `archived_at: string or null`
289299
from line 317
307317
308318 - `expires_at: optional string or null`
309319
310 A timestamp in RFC 3339 format
320 When the credential's access token expires, in RFC 3339. Absent if the expiry isn't known.
311321
312322 format: date-time
313323
from line 327
317327
318328 - `client_id: string`
319329
320 OAuth client ID.
330 The OAuth client ID used when refreshing the access token.
321331
322332 - `token_endpoint: string`
323333
from line 407
397407
398408 - `allowed_hosts: array of string`
399409
400 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.
410 The destination hosts of the outbound requests that the credential's secret is substituted into.
411
412 An entry matches the request host exactly. An entry such as `*.example.com` matches any subdomain of `example.com` but not `example.com` itself.
401413
402414 - `secret_name: string`
403415
api/beta/vaults/delete Changed · +4 / -4 lines
# Delete a Vault # Delete Vault
from line 1
11---
2title: Delete Vault
2title: Delete a Vault
33url: https://platform.claude.com/docs/en/api/beta/vaults/delete
44---
55
6# Delete Vault
6# Delete a Vault
77
88**DELETE** `/v1/vaults/{vault_id}`
99
10Delete Vault
10Delete a Vault
1111
1212## Path parameters
1313
from line 147
147147
148148 - `id: string`
149149
150 Unique identifier of the deleted vault.
150 The unique ID of the deleted vault (`vlt_...`).
151151
152152## Example
153153
api/beta/vaults/list Changed · +4 / -4 lines
from line 13
1313
1414- `include_archived: optional boolean`
1515
16 Whether to include archived vaults in the results.
16 Whether to include archived vaults in the results. Defaults to `false`.
1717
1818- `limit: optional number`
1919
from line 23
2323
2424- `page: optional string`
2525
26 Opaque pagination token from a previous `list_vaults` response.
26 The `next_page` value from a previous [List Vaults](https://platform.claude.com/docs/en/api/beta/vaults/list?sdk_languages=http) response, to get the next page. Leave it out to get the first page.
2727
2828## Headers
2929
from line 151
151151
152152- `data: optional array of BetaManagedAgentsVault`
153153
154 List of vaults.
154 The vaults on this page, newest first.
155155
156156 - `type: "vault"`
157157
158158 - `id: string`
159159
160 Unique identifier for the vault.
160 The unique ID of the vault (`vlt_...`).
161161
162162 - `archived_at: string or null`
163163
api/beta/vaults/retrieve Changed · +4 / -4 lines
# Retrieve a Vault # Get Vault
from line 1
11---
2title: Get Vault
2title: Retrieve a Vault
33url: https://platform.claude.com/docs/en/api/beta/vaults/retrieve
44---
55
6# Get Vault
6# Retrieve a Vault
77
88**GET** `/v1/vaults/{vault_id}`
99
10Get Vault
10Retrieve a Vault
1111
1212## Path parameters
1313
from line 147
147147
148148 - `id: string`
149149
150 Unique identifier for the vault.
150 The unique ID of the vault (`vlt_...`).
151151
152152 - `archived_at: string or null`
153153
api/beta/vaults/update Changed · +4 / -4 lines
# Update a Vault # Update Vault
from line 1
11---
2title: Update Vault
2title: Update a Vault
33url: https://platform.claude.com/docs/en/api/beta/vaults/update
44---
55
6# Update Vault
6# Update a Vault
77
88**POST** `/v1/vaults/{vault_id}`
99
10Update Vault
10Update a Vault
1111
1212## Path parameters
1313
from line 159
159159
160160 - `id: string`
161161
162 Unique identifier for the vault.
162 The unique ID of the vault (`vlt_...`).
163163
164164 - `archived_at: string or null`
165165
api/compliance Changed · +2289 / -4 lines
## Compliance API › Organizations › User Preferences ### List organization members' personal preferences
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 19
1919
2020#### Query parameters
2121
22- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
22- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
2323
2424 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2525
from line 575
575575
576576 A security scan of a plugin completed and produced a verdict.
577577
578 - `"claude_plugin_served_version_updated"`
579
580 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
581
578582 - `"claude_plugin_updated"`
579583
580584 Plugin was updated.
581585
586 - `"claude_plugin_version_created"`
587
588 A new version of a plugin was created.
589
582590 - `"claude_project_archived"`
583591
584592 A Claude project was archived.
from line 1291
12831291
12841292 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
12851293
1294 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
1295
1296 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
1297
1298 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
1299
1300 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
1301
12861302 - `"org_hipaa_self_serve_enabled"`
12871303
12881304 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 1359
13431359
13441360 Admin bulk-dismissed join requests.
13451361
1362 - `"org_library_submission_created"`
1363
1364 A member submitted one of their own skills or plugins for publication into the organization library.
1365
1366 - `"org_library_submission_resolved"`
1367
1368 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
1369
1370 - `"org_library_submission_withdrawn"`
1371
1372 A pending submission to the organization library was withdrawn before any reviewer decided on it.
1373
13461374 - `"org_magic_link_second_factor_toggled"`
13471375
13481376 Organization magic link second factor was toggled.
13491377
1378 - `"org_member_avatar_removed"`
1379
1380 An administrator removed another member's profile picture.
1381
13501382 - `"org_member_invites_disabled"`
13511383
13521384 Admin disabled member invites for the organization.
from line 2222
21902222
21912223 format: date-time
21922224
2193- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
2225- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
21942226
21952227 Exclude activities of these types. Cannot be combined with `activity_types[]`.
21962228
from line 2778
27462778
27472779 A security scan of a plugin completed and produced a verdict.
27482780
2781 - `"claude_plugin_served_version_updated"`
2782
2783 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
2784
27492785 - `"claude_plugin_updated"`
27502786
27512787 Plugin was updated.
27522788
2789 - `"claude_plugin_version_created"`
2790
2791 A new version of a plugin was created.
2792
27532793 - `"claude_project_archived"`
27542794
27552795 A Claude project was archived.
from line 3494
34543494
34553495 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
34563496
3497 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
3498
3499 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
3500
3501 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
3502
3503 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
3504
34573505 - `"org_hipaa_self_serve_enabled"`
34583506
34593507 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 3562
35143562
35153563 Admin bulk-dismissed join requests.
35163564
3565 - `"org_library_submission_created"`
3566
3567 A member submitted one of their own skills or plugins for publication into the organization library.
3568
3569 - `"org_library_submission_resolved"`
3570
3571 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
3572
3573 - `"org_library_submission_withdrawn"`
3574
3575 A pending submission to the organization library was withdrawn before any reviewer decided on it.
3576
35173577 - `"org_magic_link_second_factor_toggled"`
35183578
35193579 Organization magic link second factor was toggled.
35203580
3581 - `"org_member_avatar_removed"`
3582
3583 An administrator removed another member's profile picture.
3584
35213585 - `"org_member_invites_disabled"`
35223586
35233587 Admin disabled member invites for the organization.
from line 4423
43594423
43604424#### Returns
43614425
4362- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 525 more`
4426- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 533 more`
43634427
43644428 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
43654429
from line 9091
90279091
90289092 The read-axis sharing mode before the change: `owner`, `users`, `org`, or `public` (anyone on the internet).
90299093
9094 - `previous_read_agent_ids: optional array of string`
9095
9096 The Claude agents (`cagt_…` identifiers) whose channel held view access to the artifact before the change. Empty when none.
9097
9098 - `previous_read_group_ids: optional array of string`
9099
9100 The admin-managed groups (`rbac_group_…` identifiers) whose members held view access to the artifact before the change. Edit access implies view access, so every `previous_write_group_ids` entry also appears here. Empty when none.
9101
90309102 - `previous_user_count: optional number or null`
90319103
90329104 The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`.
90339105
9106 - `previous_write_agent_ids: optional array of string`
9107
9108 The Claude agents (`cagt_…` identifiers) whose channel held edit access to the artifact before the change. Empty when none.
9109
9110 - `previous_write_group_ids: optional array of string`
9111
9112 The admin-managed groups (`rbac_group_…` identifiers) whose members held edit access to the artifact before the change. Empty when none.
9113
90349114 - `previous_write_mode: optional string or null`
90359115
90369116 The write-axis sharing mode before the change: `owner`, `users`, or `org`.
from line 9119
90399119
90409120 The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`.
90419121
9122 - `read_agent_ids: optional array of string`
9123
9124 The Claude agents (`cagt_…` identifiers) whose channel holds view access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9125
9126 - `read_group_ids: optional array of string`
9127
9128 The admin-managed groups (`rbac_group_…` identifiers) whose members hold view access to the artifact after the change (including every `write_group_ids` entry). Reflects the standing grants, so it is populated on every sharing update for an artifact shared with groups, not only when a group grant changed. Empty when none.
9129
9130 - `write_agent_ids: optional array of string`
9131
9132 The Claude agents (`cagt_…` identifiers) whose channel holds edit access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9133
9134 - `write_group_ids: optional array of string`
9135
9136 The admin-managed groups (`rbac_group_…` identifiers) whose members hold edit access to the artifact after the change. Reflects the standing grants, like `read_group_ids`. Empty when none.
9137
90429138 - `ClaudeArtifactViewed object`
90439139
90449140 An artifact was viewed.
from line 9373
92779373
92789374 - `organization_uuid: optional string or null`
92799375
9280 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API).
9281
9282 - `AuditLogExportAccessed object`
9283
9284 Audit log export file was accessed/downloaded via signed URL.
9285
9286 - `type: optional "audit_log_export_accessed"`
9287
9288 default: audit_log_export_accessed
9289
9290 - `actor: APIActor or UserActor or UnauthenticatedUserActor or 8 more`
9291
9292 - `APIActor object`
9293
9294 - `type: optional "api_actor"`
9295
9296 default: api_actor
9297
9298 - `api_key_id: string`
9299
9300 - `ip_address: string`
9301
9302 - `user_agent: string`
9303
9304 - `UserActor object`
9305
9306 - `type: optional "user_actor"`
9307
9308 default: user_actor
9309
9310 - `email_address: string`
9311
9312 format: email
9313
9314 - `ip_address: string`
9315
9316 - `user_agent: string`
9317
9318 - `user_id: string`
9319
9320 - `UnauthenticatedUserActor object`
9321
9322 - `type: optional "unauthenticated_user_actor"`
9323
9324 default: unauthenticated_user_actor
9325
9326 - `ip_address: string`
9327
9328 - `user_agent: string`
9329
9330 - `unauthenticated_email_address: optional string or null`
9331
9332 format: email
9333
9334 - `AnthropicActor object`
9335
9336 - `type: optional "anthropic_actor"`
9337
9338 default: anthropic_actor
9339
9340 - `email_address: optional string or null`
9341
9342 format: email
9343
9344 - `SystemActor object`
9345
9346 Automated background processing performed by Anthropic systems, acting
9347 without a user or customer credential.
9348
9349 - `type: optional "system_actor"`
9350
9351 default: system_actor
9352
9353 - `service: optional string or null`
9354
9355 Name of the automated process that performed the action, when known.
9356
9357 - `AdminAPIKeyActor object`
9358
9359 - `type: optional "admin_api_key_actor"`
9360
9361 default: admin_api_key_actor
9362
9363 - `admin_api_key_id: string`
9364
9365 - `ip_address: string`
9366
9367 - `user_agent: string`
9368
9369 - `ServiceAccountActor object`
9370
9371 - `type: optional "service_account_actor"`
9372
9373 default: service_account_actor
9374
9375 - `ip_address: string`
9376
9377 - `service_account_id: string`
9378
9379 - `user_agent: string`
9380
9381 - `ScimDirectorySyncActor object`
9382
9383 - `type: optional "scim_directory_sync_actor"`
9384
9385 default: scim_directory_sync_actor
9386
9387 - `directory_id: string`
9388
9389 - `workos_event_id: string`
9390
9391 - `idp_connection_type: optional string or null`
9392
9393 - `FederatedIdentityActor object`
9394
9395 A federated external workload authenticated via a verified OIDC token.
9396
9397 Carries the verified issuer, subject, and audience claims from the
9398 presented JWT.
9399
9400 - `type: optional "federated_identity_actor"`
9401
9402 default: federated_identity_actor
9403
9404 - `issuer: string`
9405
9406 - `subject: string`
9407
9408 - `audience: optional array of string`
9409
9410 - `ip_address: optional string or null`
9411
9412 - `user_agent: optional string or null`
9413
9414 - `FederatedActor object`
9415
9416 An external identity asserted by a trusted provider — a cloud-provider
9417 gateway or a customer-registered federation issuer — acting without an
9418 Anthropic-provisioned account or service account.
9419
9420 - `type: optional "federated_actor"`
9421
9422 default: federated_actor
9423
9424 - `provider: FederatedActorAwsProvider or FederatedActorAzureProvider or FederatedActorGcpProvider or FederatedActorOidcProvider`
9425
9426 - `FederatedActorAwsProvider object`
9427
9428 Asserting party: the AWS account the organization is bound to.
9429
9430 - `type: optional "aws"`
9431
9432 default: aws
9433
9434 - `account_id: string`
9435
9436 - `signed_principal: string`
9437
9438 The AWS-signed ARN of the IAM principal that requested the token.
9439
9440 - `FederatedActorAzureProvider object`
9441
9442 Asserting party: the Azure subscription the organization is bound to.
9443
9444 - `type: optional "azure"`
9445
9446 default: azure
9447
9448 - `subscription_id: string`
9449
9450 - `FederatedActorGcpProvider object`
9451
9452 Asserting party: the GCP project the organization is bound to.
9453
9454 - `type: optional "gcp"`
9455
9456 default: gcp
9457
9458 - `project_number: string`
9459
9460 - `FederatedActorOidcProvider object`
9461
9462 Asserting party: a customer-registered OIDC federation issuer.
9463
9464 - `type: optional "oidc"`
9465
9466 default: oidc
9467
9468 - `issuer: optional string or null`
9469
9470 The federation issuer's URL. Null when the presented credential failed verification.
9471
9472 - `ip_address: optional string or null`
9473
9474 - `subject: optional string or null`
9475
9476 The provider's verified identifier for the caller; its form depends on the provider.
9477
9478 - `user_agent: optional string or null`
9479
9480 - `AttestedDeviceActor object`
9481
9482
9376 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for examp
api/compliance/activities Changed · +4276 / -4 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 17
1717
1818### Query parameters
1919
20- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
20- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
2121
2222 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2323
from line 573
573573
574574 A security scan of a plugin completed and produced a verdict.
575575
576 - `"claude_plugin_served_version_updated"`
577
578 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
579
576580 - `"claude_plugin_updated"`
577581
578582 Plugin was updated.
579583
584 - `"claude_plugin_version_created"`
585
586 A new version of a plugin was created.
587
580588 - `"claude_project_archived"`
581589
582590 A Claude project was archived.
from line 1289
12811289
12821290 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
12831291
1292 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
1293
1294 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
1295
1296 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
1297
1298 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
1299
12841300 - `"org_hipaa_self_serve_enabled"`
12851301
12861302 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 1357
13411357
13421358 Admin bulk-dismissed join requests.
13431359
1360 - `"org_library_submission_created"`
1361
1362 A member submitted one of their own skills or plugins for publication into the organization library.
1363
1364 - `"org_library_submission_resolved"`
1365
1366 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
1367
1368 - `"org_library_submission_withdrawn"`
1369
1370 A pending submission to the organization library was withdrawn before any reviewer decided on it.
1371
13441372 - `"org_magic_link_second_factor_toggled"`
13451373
13461374 Organization magic link second factor was toggled.
13471375
1376 - `"org_member_avatar_removed"`
1377
1378 An administrator removed another member's profile picture.
1379
13481380 - `"org_member_invites_disabled"`
13491381
13501382 Admin disabled member invites for the organization.
from line 2220
21882220
21892221 format: date-time
21902222
2191- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
2223- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
21922224
21932225 Exclude activities of these types. Cannot be combined with `activity_types[]`.
21942226
from line 2776
27442776
27452777 A security scan of a plugin completed and produced a verdict.
27462778
2779 - `"claude_plugin_served_version_updated"`
2780
2781 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
2782
27472783 - `"claude_plugin_updated"`
27482784
27492785 Plugin was updated.
27502786
2787 - `"claude_plugin_version_created"`
2788
2789 A new version of a plugin was created.
2790
27512791 - `"claude_project_archived"`
27522792
27532793 A Claude project was archived.
from line 3492
34523492
34533493 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
34543494
3495 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
3496
3497 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
3498
3499 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
3500
3501 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
3502
34553503 - `"org_hipaa_self_serve_enabled"`
34563504
34573505 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 3560
35123560
35133561 Admin bulk-dismissed join requests.
35143562
3563 - `"org_library_submission_created"`
3564
3565 A member submitted one of their own skills or plugins for publication into the organization library.
3566
3567 - `"org_library_submission_resolved"`
3568
3569 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
3570
3571 - `"org_library_submission_withdrawn"`
3572
3573 A pending submission to the organization library was withdrawn before any reviewer decided on it.
3574
35153575 - `"org_magic_link_second_factor_toggled"`
35163576
35173577 Organization magic link second factor was toggled.
35183578
3579 - `"org_member_avatar_removed"`
3580
3581 An administrator removed another member's profile picture.
3582
35193583 - `"org_member_invites_disabled"`
35203584
35213585 Admin disabled member invites for the organization.
from line 4421
43574421
43584422### Returns
43594423
4360- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 525 more`
4424- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 533 more`
43614425
43624426 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
43634427
from line 9089
90259089
90269090 The read-axis sharing mode before the change: `owner`, `users`, `org`, or `public` (anyone on the internet).
90279091
9092 - `previous_read_agent_ids: optional array of string`
9093
9094 The Claude agents (`cagt_…` identifiers) whose channel held view access to the artifact before the change. Empty when none.
9095
9096 - `previous_read_group_ids: optional array of string`
9097
9098 The admin-managed groups (`rbac_group_…` identifiers) whose members held view access to the artifact before the change. Edit access implies view access, so every `previous_write_group_ids` entry also appears here. Empty when none.
9099
90289100 - `previous_user_count: optional number or null`
90299101
90309102 The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`.
90319103
9104 - `previous_write_agent_ids: optional array of string`
9105
9106 The Claude agents (`cagt_…` identifiers) whose channel held edit access to the artifact before the change. Empty when none.
9107
9108 - `previous_write_group_ids: optional array of string`
9109
9110 The admin-managed groups (`rbac_group_…` identifiers) whose members held edit access to the artifact before the change. Empty when none.
9111
90329112 - `previous_write_mode: optional string or null`
90339113
90349114 The write-axis sharing mode before the change: `owner`, `users`, or `org`.
from line 9117
90379117
90389118 The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`.
90399119
9120 - `read_agent_ids: optional array of string`
9121
9122 The Claude agents (`cagt_…` identifiers) whose channel holds view access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9123
9124 - `read_group_ids: optional array of string`
9125
9126 The admin-managed groups (`rbac_group_…` identifiers) whose members hold view access to the artifact after the change (including every `write_group_ids` entry). Reflects the standing grants, so it is populated on every sharing update for an artifact shared with groups, not only when a group grant changed. Empty when none.
9127
9128 - `write_agent_ids: optional array of string`
9129
9130 The Claude agents (`cagt_…` identifiers) whose channel holds edit access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9131
9132 - `write_group_ids: optional array of string`
9133
9134 The admin-managed groups (`rbac_group_…` identifiers) whose members hold edit access to the artifact after the change. Reflects the standing grants, like `read_group_ids`. Empty when none.
9135
90409136 - `ClaudeArtifactViewed object`
90419137
90429138 An artifact was viewed.
from line 9371
92759371
92769372 - `organization_uuid: optional string or null`
92779373
9278 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API).
9279
9280 - `AuditLogExportAccessed object`
9281
9282 Audit log export file was accessed/downloaded via signed URL.
9283
9284 - `type: optional "audit_log_export_accessed"`
9285
9286 default: audit_log_export_accessed
9287
9288 - `actor: APIActor or UserActor or UnauthenticatedUserActor or 8 more`
9289
9290 - `APIActor object`
9291
9292 - `type: optional "api_actor"`
9293
9294 default: api_actor
9295
9296 - `api_key_id: string`
9297
9298 - `ip_address: string`
9299
9300 - `user_agent: string`
9301
9302 - `UserActor object`
9303
9304 - `type: optional "user_actor"`
9305
9306 default: user_actor
9307
9308 - `email_address: string`
9309
9310 format: email
9311
9312 - `ip_address: string`
9313
9314 - `user_agent: string`
9315
9316 - `user_id: string`
9317
9318 - `UnauthenticatedUserActor object`
9319
9320 - `type: optional "unauthenticated_user_actor"`
9321
9322 default: unauthenticated_user_actor
9323
9324 - `ip_address: string`
9325
9326 - `user_agent: string`
9327
9328 - `unauthenticated_email_address: optional string or null`
9329
9330 format: email
9331
9332 - `AnthropicActor object`
9333
9334 - `type: optional "anthropic_actor"`
9335
9336 default: anthropic_actor
9337
9338 - `email_address: optional string or null`
9339
9340 format: email
9341
9342 - `SystemActor object`
9343
9344 Automated background processing performed by Anthropic systems, acting
9345 without a user or customer credential.
9346
9347 - `type: optional "system_actor"`
9348
9349 default: system_actor
9350
9351 - `service: optional string or null`
9352
9353 Name of the automated process that performed the action, when known.
9354
9355 - `AdminAPIKeyActor object`
9356
9357 - `type: optional "admin_api_key_actor"`
9358
9359 default: admin_api_key_actor
9360
9361 - `admin_api_key_id: string`
9362
9363 - `ip_address: string`
9364
9365 - `user_agent: string`
9366
9367 - `ServiceAccountActor object`
9368
9369 - `type: optional "service_account_actor"`
9370
9371 default: service_account_actor
9372
9373 - `ip_address: string`
9374
9375 - `service_account_id: string`
9376
9377 - `user_agent: string`
9378
9379 - `ScimDirectorySyncActor object`
9380
9381 - `type: optional "scim_directory_sync_actor"`
9382
9383 default: scim_directory_sync_actor
9384
9385 - `directory_id: string`
9386
9387 - `workos_event_id: string`
9388
9389 - `idp_connection_type: optional string or null`
9390
9391 - `FederatedIdentityActor object`
9392
9393 A federated external workload authenticated via a verified OIDC token.
9394
9395 Carries the verified issuer, subject, and audience claims from the
9396 presented JWT.
9397
9398 - `type: optional "federated_identity_actor"`
9399
9400 default: federated_identity_actor
9401
9402 - `issuer: string`
9403
9404 - `subject: string`
9405
9406 - `audience: optional array of string`
9407
9408 - `ip_address: optional string or null`
9409
9410 - `user_agent: optional string or null`
9411
9412 - `FederatedActor object`
9413
9414 An external identity asserted by a trusted provider — a cloud-provider
9415 gateway or a customer-registered federation issuer — acting without an
9416 Anthropic-provisioned account or service account.
9417
9418 - `type: optional "federated_actor"`
9419
9420 default: federated_actor
9421
9422 - `provider: FederatedActorAwsProvider or FederatedActorAzureProvider or FederatedActorGcpProvider or FederatedActorOidcProvider`
9423
9424 - `FederatedActorAwsProvider object`
9425
9426 Asserting party: the AWS account the organization is bound to.
9427
9428 - `type: optional "aws"`
9429
9430 default: aws
9431
9432 - `account_id: string`
9433
9434 - `signed_principal: string`
9435
9436 The AWS-signed ARN of the IAM principal that requested the token.
9437
9438 - `FederatedActorAzureProvider object`
9439
9440 Asserting party: the Azure subscription the organization is bound to.
9441
9442 - `type: optional "azure"`
9443
9444 default: azure
9445
9446 - `subscription_id: string`
9447
9448 - `FederatedActorGcpProvider object`
9449
9450 Asserting party: the GCP project the organization is bound to.
9451
9452 - `type: optional "gcp"`
9453
9454 default: gcp
9455
9456 - `project_number: string`
9457
9458 - `FederatedActorOidcProvider object`
9459
9460 Asserting party: a customer-registered OIDC federation issuer.
9461
9462 - `type: optional "oidc"`
9463
9464 default: oidc
9465
9466 - `issuer: optional string or null`
9467
9468 The federation issuer's URL. Null when the presented credential failed verification.
9469
9470 - `ip_address: optional string or null`
9471
9472 - `subject: optional string or null`
9473
9474 The provider's verified identifier for the caller; its form depends on the provider.
9475
9476 - `user_agent: optional string or null`
9477
9478 - `AttestedDeviceActor object`
9479
9480 An attested mobile device authe
9374 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or call
api/compliance/activities/list Changed · +2171 / -3 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 15
1515
1616## Query parameters
1717
18- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
18- `activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
1919
2020 Filter activities by type. See the response `data` schema for the additional fields each type returns. Cannot be combined with `exclude_activity_types[]`.
2121
from line 571
571571
572572 A security scan of a plugin completed and produced a verdict.
573573
574 - `"claude_plugin_served_version_updated"`
575
576 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
577
574578 - `"claude_plugin_updated"`
575579
576580 Plugin was updated.
577581
582 - `"claude_plugin_version_created"`
583
584 A new version of a plugin was created.
585
578586 - `"claude_project_archived"`
579587
580588 A Claude project was archived.
from line 1287
12791287
12801288 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
12811289
1290 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
1291
1292 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
1293
1294 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
1295
1296 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
1297
12821298 - `"org_hipaa_self_serve_enabled"`
12831299
12841300 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 1355
13391355
13401356 Admin bulk-dismissed join requests.
13411357
1358 - `"org_library_submission_created"`
1359
1360 A member submitted one of their own skills or plugins for publication into the organization library.
1361
1362 - `"org_library_submission_resolved"`
1363
1364 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
1365
1366 - `"org_library_submission_withdrawn"`
1367
1368 A pending submission to the organization library was withdrawn before any reviewer decided on it.
1369
13421370 - `"org_magic_link_second_factor_toggled"`
13431371
13441372 Organization magic link second factor was toggled.
13451373
1374 - `"org_member_avatar_removed"`
1375
1376 An administrator removed another member's profile picture.
1377
13461378 - `"org_member_invites_disabled"`
13471379
13481380 Admin disabled member invites for the organization.
from line 2218
21862218
21872219 format: date-time
21882220
2189- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 525 more`
2221- `exclude_activity_types: optional array of "abuse_decision_received" or "account_deleted" or "admin_api_key_created" or 533 more`
21902222
21912223 Exclude activities of these types. Cannot be combined with `activity_types[]`.
21922224
from line 2774
27422774
27432775 A security scan of a plugin completed and produced a verdict.
27442776
2777 - `"claude_plugin_served_version_updated"`
2778
2779 A plugin's served version was updated: an administrator or the owner chose a version, a saved version became the served version, or an accepted library submission was published into the plugin.
2780
27452781 - `"claude_plugin_updated"`
27462782
27472783 Plugin was updated.
27482784
2785 - `"claude_plugin_version_created"`
2786
2787 A new version of a plugin was created.
2788
27492789 - `"claude_project_archived"`
27502790
27512791 A Claude project was archived.
from line 3490
34503490
34513491 An owner of the organization accepted the terms for using artifacts with the HIPAA configuration enabled.
34523492
3493 - `"org_hipaa_claude_code_cowork_restrictions_deferred"`
3494
3495 The HIPAA configuration for Claude Code (local mode) and Cowork (local mode) was left off for the organization when the configuration launched, and stays off until it is applied.
3496
3497 - `"org_hipaa_claude_code_cowork_restrictions_enabled"`
3498
3499 The HIPAA configuration was applied to Claude Code (local mode) and Cowork (local mode) for the organization.
3500
34533501 - `"org_hipaa_self_serve_enabled"`
34543502
34553503 A primary owner accepted the Business Associate Agreement and enabled the HIPAA configuration for the organization through the self-serve flow.
from line 3558
35103558
35113559 Admin bulk-dismissed join requests.
35123560
3561 - `"org_library_submission_created"`
3562
3563 A member submitted one of their own skills or plugins for publication into the organization library.
3564
3565 - `"org_library_submission_resolved"`
3566
3567 A member's submission of a skill or plugin to the organization library was accepted or denied, or an accepted one finished publishing.
3568
3569 - `"org_library_submission_withdrawn"`
3570
3571 A pending submission to the organization library was withdrawn before any reviewer decided on it.
3572
35133573 - `"org_magic_link_second_factor_toggled"`
35143574
35153575 Organization magic link second factor was toggled.
35163576
3577 - `"org_member_avatar_removed"`
3578
3579 An administrator removed another member's profile picture.
3580
35173581 - `"org_member_invites_disabled"`
35183582
35193583 Admin disabled member invites for the organization.
from line 4419
43554419
43564420## Returns
43574421
4358- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 525 more`
4422- `data: optional array of AbuseDecisionReceived or AccountDeleted or AdminAPIKeyCreated or 533 more`
43594423
43604424 List of activity records. Each element's `type` field identifies which activity it is and which additional fields are present.
43614425
from line 9087
90239087
90249088 The read-axis sharing mode before the change: `owner`, `users`, `org`, or `public` (anyone on the internet).
90259089
9090 - `previous_read_agent_ids: optional array of string`
9091
9092 The Claude agents (`cagt_…` identifiers) whose channel held view access to the artifact before the change. Empty when none.
9093
9094 - `previous_read_group_ids: optional array of string`
9095
9096 The admin-managed groups (`rbac_group_…` identifiers) whose members held view access to the artifact before the change. Edit access implies view access, so every `previous_write_group_ids` entry also appears here. Empty when none.
9097
90269098 - `previous_user_count: optional number or null`
90279099
90289100 The number of accounts on the explicit read allowlist before the change. Only meaningful when `previous_mode` is `users`.
90299101
9102 - `previous_write_agent_ids: optional array of string`
9103
9104 The Claude agents (`cagt_…` identifiers) whose channel held edit access to the artifact before the change. Empty when none.
9105
9106 - `previous_write_group_ids: optional array of string`
9107
9108 The admin-managed groups (`rbac_group_…` identifiers) whose members held edit access to the artifact before the change. Empty when none.
9109
90309110 - `previous_write_mode: optional string or null`
90319111
90329112 The write-axis sharing mode before the change: `owner`, `users`, or `org`.
from line 9115
90359115
90369116 The number of accounts on the explicit write allowlist before the change. Only meaningful when `previous_write_mode` is `users`.
90379117
9118 - `read_agent_ids: optional array of string`
9119
9120 The Claude agents (`cagt_…` identifiers) whose channel holds view access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9121
9122 - `read_group_ids: optional array of string`
9123
9124 The admin-managed groups (`rbac_group_…` identifiers) whose members hold view access to the artifact after the change (including every `write_group_ids` entry). Reflects the standing grants, so it is populated on every sharing update for an artifact shared with groups, not only when a group grant changed. Empty when none.
9125
9126 - `write_agent_ids: optional array of string`
9127
9128 The Claude agents (`cagt_…` identifiers) whose channel holds edit access to the artifact after the change. Reflects the standing grants, so it is populated on every sharing update for an artifact shared with agents, not only when an agent grant changed. Empty when none.
9129
9130 - `write_group_ids: optional array of string`
9131
9132 The admin-managed groups (`rbac_group_…` identifiers) whose members hold edit access to the artifact after the change. Reflects the standing grants, like `read_group_ids`. Empty when none.
9133
90389134 - `ClaudeArtifactViewed object`
90399135
90409136 An artifact was viewed.
from line 9369
92739369
92749370 - `organization_uuid: optional string or null`
92759371
9276 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or calls to the Compliance API).
9277
9278 - `AuditLogExportAccessed object`
9279
9280 Audit log export file was accessed/downloaded via signed URL.
9281
9282 - `type: optional "audit_log_export_accessed"`
9283
9284 default: audit_log_export_accessed
9285
9286 - `actor: APIActor or UserActor or UnauthenticatedUserActor or 8 more`
9287
9288 - `APIActor object`
9289
9290 - `type: optional "api_actor"`
9291
9292 default: api_actor
9293
9294 - `api_key_id: string`
9295
9296 - `ip_address: string`
9297
9298 - `user_agent: string`
9299
9300 - `UserActor object`
9301
9302 - `type: optional "user_actor"`
9303
9304 default: user_actor
9305
9306 - `email_address: string`
9307
9308 format: email
9309
9310 - `ip_address: string`
9311
9312 - `user_agent: string`
9313
9314 - `user_id: string`
9315
9316 - `UnauthenticatedUserActor object`
9317
9318 - `type: optional "unauthenticated_user_actor"`
9319
9320 default: unauthenticated_user_actor
9321
9322 - `ip_address: string`
9323
9324 - `user_agent: string`
9325
9326 - `unauthenticated_email_address: optional string or null`
9327
9328 format: email
9329
9330 - `AnthropicActor object`
9331
9332 - `type: optional "anthropic_actor"`
9333
9334 default: anthropic_actor
9335
9336 - `email_address: optional string or null`
9337
9338 format: email
9339
9340 - `SystemActor object`
9341
9342 Automated background processing performed by Anthropic systems, acting
9343 without a user or customer credential.
9344
9345 - `type: optional "system_actor"`
9346
9347 default: system_actor
9348
9349 - `service: optional string or null`
9350
9351 Name of the automated process that performed the action, when known.
9352
9353 - `AdminAPIKeyActor object`
9354
9355 - `type: optional "admin_api_key_actor"`
9356
9357 default: admin_api_key_actor
9358
9359 - `admin_api_key_id: string`
9360
9361 - `ip_address: string`
9362
9363 - `user_agent: string`
9364
9365 - `ServiceAccountActor object`
9366
9367 - `type: optional "service_account_actor"`
9368
9369 default: service_account_actor
9370
9371 - `ip_address: string`
9372
9373 - `service_account_id: string`
9374
9375 - `user_agent: string`
9376
9377 - `ScimDirectorySyncActor object`
9378
9379 - `type: optional "scim_directory_sync_actor"`
9380
9381 default: scim_directory_sync_actor
9382
9383 - `directory_id: string`
9384
9385 - `workos_event_id: string`
9386
9387 - `idp_connection_type: optional string or null`
9388
9389 - `FederatedIdentityActor object`
9390
9391 A federated external workload authenticated via a verified OIDC token.
9392
9393 Carries the verified issuer, subject, and audience claims from the
9394 presented JWT.
9395
9396 - `type: optional "federated_identity_actor"`
9397
9398 default: federated_identity_actor
9399
9400 - `issuer: string`
9401
9402 - `subject: string`
9403
9404 - `audience: optional array of string`
9405
9406 - `ip_address: optional string or null`
9407
9408 - `user_agent: optional string or null`
9409
9410 - `FederatedActor object`
9411
9412 An external identity asserted by a trusted provider — a cloud-provider
9413 gateway or a customer-registered federation issuer — acting without an
9414 Anthropic-provisioned account or service account.
9415
9416 - `type: optional "federated_actor"`
9417
9418 default: federated_actor
9419
9420 - `provider: FederatedActorAwsProvider or FederatedActorAzureProvider or FederatedActorGcpProvider or FederatedActorOidcProvider`
9421
9422 - `FederatedActorAwsProvider object`
9423
9424 Asserting party: the AWS account the organization is bound to.
9425
9426 - `type: optional "aws"`
9427
9428 default: aws
9429
9430 - `account_id: string`
9431
9432 - `signed_principal: string`
9433
9434 The AWS-signed ARN of the IAM principal that requested the token.
9435
9436 - `FederatedActorAzureProvider object`
9437
9438 Asserting party: the Azure subscription the organization is bound to.
9439
9440 - `type: optional "azure"`
9441
9442 default: azure
9443
9444 - `subscription_id: string`
9445
9446 - `FederatedActorGcpProvider object`
9447
9448 Asserting party: the GCP project the organization is bound to.
9449
9450 - `type: optional "gcp"`
9451
9452 default: gcp
9453
9454 - `project_number: string`
9455
9456 - `FederatedActorOidcProvider object`
9457
9458 Asserting party: a customer-registered OIDC federation issuer.
9459
9460 - `type: optional "oidc"`
9461
9462 default: oidc
9463
9464 - `issuer: optional string or null`
9465
9466 The federation issuer's URL. Null when the presented credential failed verification.
9467
9468 - `ip_address: optional string or null`
9469
9470 - `subject: optional string or null`
9471
9472 The provider's verified identifier for the caller; its form depends on the provider.
9473
9474 - `user_agent: optional string or null`
9475
9476 - `AttestedDeviceActor object`
9477
9478 An attested mobile device a
9372 Organization UUID where the activity occurred. Null when the activity is not tied to an organization (for example, login and logout events or
api/compliance/organizations Changed · +117 / -0 lines
## Organizations › User Preferences ### List organization members' personal preferences
from line 227
227227}
228228```
229229
230## Organizations › User Preferences
231
232### List organization members' personal preferences
233
234**GET** `/v1/compliance/organizations/{org_uuid}/user_preferences`
235
236List the personal preferences of an organization's current members.
237
238Returns each member's "Instructions for Claude" and Cowork "Global
239instructions" text. Both are account-level settings: the same text is
240returned under every organization the member belongs to. Members are
241listed in the order they joined the organization, oldest first; use
242`limit` and `page` to paginate. A page may hold fewer than `limit`
243rows, or none at all, without being the last page: the server bounds
244the work it does per request. Follow `next_page` until it is `null`.
245
246#### Path parameters
247
248- `org_uuid: string`
249
250 The organization's UUID
251
252#### Query parameters
253
254- `include_unset: optional boolean`
255
256 When true, list every current member, with `null` for each value they have not set. By default only members with at least one value set are listed.
257
258 default: false
259
260- `limit: optional number`
261
262 Maximum results (default: 20, max: 100)
263
264 default: 20, minimum: 1, maximum: 100
265
266- `page: optional string`
267
268 Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
269
270- `user_ids: optional array of string`
271
272 Restrict the list to these users (max 10 per request). An entry that does not name a current member of the organization matches nothing. Omit to list every eligible member. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
273
274 maxItems: 10
275
276#### Headers
277
278- `"anthropic-version": optional string`
279
280 The version of the Claude API you want to use.
281
282 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
283
284- `"x-api-key": optional string`
285
286#### Returns
287
288- `data: array of object`
289
290 Current organization members in the order they joined the organization, oldest first. By default only members with at least one value set are listed; with `include_unset=true` every member is.
291
292 - `conversation_preferences: string or null`
293
294 The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
295
296 - `cowork_global_instructions: string or null`
297
298 The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
299
300 - `user: object`
301
302 The organization member.
303
304 - `id: string`
305
306 User identifier
307
308 - `email_address: string`
309
310 User's current email address
311
312- `has_more: boolean`
313
314 Whether there is a further page to request. A page can hold fewer records than `limit`, or none, and still have more: the server bounds the work it does per request.
315
316- `next_page: string or null`
317
318 Token to retrieve the next page. Use this as the 'page' parameter in your next request; `null` on the last page.
319
320#### Example
321
322```bash
323curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/user_preferences \
324 -H 'anthropic-version: 2023-06-01' \
325 -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
326```
327
328##### Response (200)
329
330```json
331{
332 "data": [
333 {
334 "conversation_preferences": "Always answer in British English.",
335 "cowork_global_instructions": "Prefer short status updates.",
336 "user": {
337 "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
338 "email_address": "[email protected]"
339 }
340 }
341 ],
342 "has_more": true,
343 "next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
344}
345```
346
230347## Organizations › Roles
231348
232349### List Compliance Roles
api/compliance/organizations/user_preferences New page · 149 lines, new page
# User Preferences ## List organization members' personal preferences ### Path parameters ### Query parameters ### Headers ### Returns ### Example #### Response (200) ## Domain types ### User Preference List Response
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: User Preferences
url: https://platform.claude.com/docs/en/api/compliance/organizations/user_preferences
---
# User Preferences
## List organization members' personal preferences
**GET** `/v1/compliance/organizations/{org_uuid}/user_preferences`
List the personal preferences of an organization's current members.
Returns each member's "Instructions for Claude" and Cowork "Global
instructions" text. Both are account-level settings: the same text is
returned under every organization the member belongs to. Members are
listed in the order they joined the organization, oldest first; use
`limit` and `page` to paginate. A page may hold fewer than `limit`
rows, or none at all, without being the last page: the server bounds
the work it does per request. Follow `next_page` until it is `null`.
### Path parameters
- `org_uuid: string`
The organization's UUID
### Query parameters
- `include_unset: optional boolean`
When true, list every current member, with `null` for each value they have not set. By default only members with at least one value set are listed.
default: false
- `limit: optional number`
Maximum results (default: 20, max: 100)
default: 20, minimum: 1, maximum: 100
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `user_ids: optional array of string`
Restrict the list to these users (max 10 per request). An entry that does not name a current member of the organization matches nothing. Omit to list every eligible member. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
maxItems: 10
### Headers
- `"anthropic-version": optional string`
The version of the Claude API you want to use.
Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
- `"x-api-key": optional string`
### Returns
- `data: array of object`
Current organization members in the order they joined the organization, oldest first. By default only members with at least one value set are listed; with `include_unset=true` every member is.
- `conversation_preferences: string or null`
The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `cowork_global_instructions: string or null`
The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `user: object`
The organization member.
- `id: string`
User identifier
- `email_address: string`
User's current email address
- `has_more: boolean`
Whether there is a further page to request. A page can hold fewer records than `limit`, or none, and still have more: the server bounds the work it does per request.
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request; `null` on the last page.
### Example
```bash
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/user_preferences \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
#### Response (200)
```json
{
"data": [
{
"conversation_preferences": "Always answer in British English.",
"cowork_global_instructions": "Prefer short status updates.",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
## Domain types
### User Preference List Response
- `UserPreferenceListResponse object`
The personal preferences a member of the organization has written in their settings.
- `conversation_preferences: string or null`
The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `cowork_global_instructions: string or null`
The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `user: object`
The organization member.
- `id: string`
User identifier
- `email_address: string`
User's current email address
api/compliance/organizations/user_preferences/list New page · 119 lines, new page
# List organization members' personal preferences ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200)
A whole new page. There's nothing to diff it against, so here is what it says.
---
title: List organization members' personal preferences
url: https://platform.claude.com/docs/en/api/compliance/organizations/user_preferences/list
---
# List organization members' personal preferences
**GET** `/v1/compliance/organizations/{org_uuid}/user_preferences`
List the personal preferences of an organization's current members.
Returns each member's "Instructions for Claude" and Cowork "Global
instructions" text. Both are account-level settings: the same text is
returned under every organization the member belongs to. Members are
listed in the order they joined the organization, oldest first; use
`limit` and `page` to paginate. A page may hold fewer than `limit`
rows, or none at all, without being the last page: the server bounds
the work it does per request. Follow `next_page` until it is `null`.
## Path parameters
- `org_uuid: string`
The organization's UUID
## Query parameters
- `include_unset: optional boolean`
When true, list every current member, with `null` for each value they have not set. By default only members with at least one value set are listed.
default: false
- `limit: optional number`
Maximum results (default: 20, max: 100)
default: 20, minimum: 1, maximum: 100
- `page: optional string`
Opaque pagination token from a previous response's `next_page` field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.
- `user_ids: optional array of string`
Restrict the list to these users (max 10 per request). An entry that does not name a current member of the organization matches nothing. Omit to list every eligible member. Enumerate IDs via `GET /v1/compliance/organizations/{org_uuid}/users`.
maxItems: 10
## Headers
- `"anthropic-version": optional string`
The version of the Claude API you want to use.
Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
- `"x-api-key": optional string`
## Returns
- `data: array of object`
Current organization members in the order they joined the organization, oldest first. By default only members with at least one value set are listed; with `include_unset=true` every member is.
- `conversation_preferences: string or null`
The member's "Instructions for Claude" text from their personal settings, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `cowork_global_instructions: string or null`
The member's "Global instructions" text for Cowork, Claude's desktop agent, with leading and trailing whitespace removed. `null` when the member has never set it or has cleared it.
- `user: object`
The organization member.
- `id: string`
User identifier
- `email_address: string`
User's current email address
- `has_more: boolean`
Whether there is a further page to request. A page can hold fewer records than `limit`, or none, and still have more: the server bounds the work it does per request.
- `next_page: string or null`
Token to retrieve the next page. Use this as the 'page' parameter in your next request; `null` on the last page.
## Example
```bash
curl https://api.anthropic.com/v1/compliance/organizations/$ORG_UUID/user_preferences \
-H 'anthropic-version: 2023-06-01' \
-H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"
```
### Response (200)
```json
{
"data": [
{
"conversation_preferences": "Always answer in British English.",
"cowork_global_instructions": "Prefer short status updates.",
"user": {
"id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
"email_address": "[email protected]"
}
}
],
"has_more": true,
"next_page": "cGFnZV90b2tlbl9leGFtcGxlXzE3MzQ1Njc4OTA="
}
```
api/models Changed · +36 / -6 lines
from line 295
295295
296296 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
297297
298 - `between_tools: CapabilitySupport`
299
300 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
301
298302 - `disabled: CapabilitySupport`
299303
300 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
304 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
301305
302306 - `enabled: CapabilitySupport`
303307
from line 458
454458 "adaptive": {
455459 "supported": true
456460 },
461 "between_tools": {
462 "supported": true
463 },
457464 "disabled": {
458465 "supported": true
459466 },
from line 753
746753
747754 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
748755
756 - `between_tools: CapabilitySupport`
757
758 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
759
749760 - `disabled: CapabilitySupport`
750761
751 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
762 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
752763
753764 - `enabled: CapabilitySupport`
754765
from line 902
891902 "adaptive": {
892903 "supported": true
893904 },
905 "between_tools": {
906 "supported": true
907 },
894908 "disabled": {
895909 "supported": true
896910 },
from line 1112
10981112
10991113 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
11001114
1115 - `between_tools: CapabilitySupport`
1116
1117 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
1118
11011119 - `disabled: CapabilitySupport`
11021120
1103 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
1121 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
11041122
11051123 - `enabled: CapabilitySupport`
11061124
from line 1252
12341252
12351253 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
12361254
1255 - `between_tools: CapabilitySupport`
1256
1257 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
1258
12371259 - `disabled: CapabilitySupport`
12381260
1239 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
1261 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
12401262
12411263 - `enabled: CapabilitySupport`
12421264
from line 1384
13621384
13631385 Whether this capability is supported by the model.
13641386
1387 - `between_tools: CapabilitySupport`
1388
1389 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
1390
13651391 - `disabled: CapabilitySupport`
13661392
1367 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
1393 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
13681394
13691395 - `enabled: CapabilitySupport`
13701396
from line 1410
13841410
13851411 Whether this capability is supported by the model.
13861412
1413 - `between_tools: CapabilitySupport`
1414
1415 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
1416
13871417 - `disabled: CapabilitySupport`
13881418
1389 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
1419 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
13901420
13911421 - `enabled: CapabilitySupport`
13921422
api/models/list Changed · +8 / -1 lines
from line 293
293293
294294 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
295295
296 - `between_tools: CapabilitySupport`
297
298 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
299
296300 - `disabled: CapabilitySupport`
297301
298 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
302 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
299303
300304 - `enabled: CapabilitySupport`
301305
from line 454
450454 "supported": true,
451455 "types": {
452456 "adaptive": {
457 "supported": true
458 },
459 "between_tools": {
453460 "supported": true
454461 },
455462 "disabled": {
api/models/retrieve Changed · +8 / -1 lines
from line 269
269269
270270 Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think).
271271
272 - `between_tools: CapabilitySupport`
273
274 Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
275
272276 - `disabled: CapabilitySupport`
273277
274 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking.
278 Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off.
275279
276280 - `enabled: CapabilitySupport`
277281
from line 416
412416 "supported": true,
413417 "types": {
414418 "adaptive": {
419 "supported": true
420 },
421 "between_tools": {
415422 "supported": true
416423 },
417424 "disabled": {
build-with-claude/citations Changed · +12 / -12 lines
from line 832
832832 source: { type: "file", file_id: uploaded.id },
833833 title: "Document Title",
834834 context: "Context about the document that will not be cited from",
835 citations: { enabled: true },
835 citations: { enabled: true }
836836 },
837837 {
838838 type: "text",
839 text: "Summarize this document.",
840 },
841 ],
842 },
843 ],
839 text: "Summarize this document."
840 }
841 ]
842 }
843 ]
844844 });
845845 console.log(citedResponse);
846846 ```
from line 1651
16511651 source: { type: "file", file_id: uploaded.id },
16521652 title: "Document Title",
16531653 context: "Context about the document that will not be cited from",
1654 citations: { enabled: true },
1654 citations: { enabled: true }
16551655 },
16561656 {
16571657 type: "text",
1658 text: "Summarize this document.",
1659 },
1660 ],
1661 },
1662 ],
1658 text: "Summarize this document."
1659 }
1660 ]
1661 }
1662 ]
16631663 });
16641664 console.log(citedResponse);
16651665 ```
build-with-claude/claude-platform-on-aws Changed · +7 / -7 lines
from line 207
207207
208208For workloads that need to hand a credential to a separate process (such as an LLM gateway, a serverless function, or a tool that supports bearer-token authentication but not SigV4), generate a short-term API key from your AWS credentials instead of provisioning a long-lived key in the AWS Console.
209209
210AWS publishes token-generator libraries for [JavaScript](https://github.com/aws/token-generator-for-aws-external-anthropic-js), [Python](https://github.com/aws/token-generator-for-aws-external-anthropic-python), and [Java](https://github.com/aws/token-generator-for-aws-external-anthropic-java). Each library reads your AWS credentials through the standard provider chain and returns a time-limited token that works with the `x-api-key` header. Token lifetime defaults to 12 hours and is capped at the lesser of your requested duration, your AWS credentials' expiry, and 12 hours. See the linked repository READMEs for installation and full configuration options.
210AWS publishes token-generator libraries for [JavaScript](https://github.com/aws/token-generator-for-aws-external-anthropic-js), [Python](https://github.com/aws/token-generator-for-aws-external-anthropic-python), and [Java](https://github.com/aws/token-generator-for-aws-external-anthropic-java). Each library reads your AWS credentials through the standard provider chain and returns a time-limited token that you send as `Authorization: Bearer <token>`. Token lifetime defaults to 12 hours and is capped at the lesser of your requested duration, your AWS credentials' expiry, and 12 hours. See the linked repository READMEs for installation and full configuration options.
211211
212212Pass the generated token to the SDK the same way you'd pass an AWS Console-generated API key:
213213
from line 405
405405
406406 ```bash CLI
407407 # Replace us-west-2 with your AWS region
408 # ant reads ANTHROPIC_API_KEY and sends it as x-api-key. Generate a key in the
409 # AWS Console (see API key authentication).
408 # ant reads ANTHROPIC_API_KEY. Generate a key in the AWS Console
409 # (see API key authentication).
410410 export ANTHROPIC_API_KEY="YOUR_AWS_API_KEY"
411411
412412 ant messages create \
from line 629
629629
630630 ```bash CLI
631631 # Replace us-west-2 with your AWS region
632 # ant reads ANTHROPIC_API_KEY and sends it as x-api-key. Generate a key in the
633 # AWS Console (see API key authentication).
632 # ant reads ANTHROPIC_API_KEY. Generate a key in the AWS Console
633 # (see API key authentication).
634634 export ANTHROPIC_API_KEY="YOUR_AWS_API_KEY"
635635
636636 ant messages create \
from line 903
903903
904904 ```bash CLI
905905 # Replace us-west-2 with your AWS region
906 # ant reads ANTHROPIC_API_KEY and sends it as x-api-key. Generate a key in the
907 # AWS Console (see API key authentication).
906 # ant reads ANTHROPIC_API_KEY. Generate a key in the AWS Console
907 # (see API key authentication).
908908 export ANTHROPIC_API_KEY="YOUR_AWS_API_KEY"
909909
910910 # --debug prints the HTTP response, including the X-Amzn-Requestid and
build-with-claude/extended-thinking Changed · +4 / -4 lines
from line 98
9898 max_tokens: 16000,
9999 thinking: {
100100 type: "enabled",
101 budget_tokens: 10000,
101 budget_tokens: 10000
102102 },
103103 messages: [
104104 {
105105 role: "user",
106 content: "Are there an infinite number of prime numbers such that n mod 4 == 3?",
107 },
108 ],
106 content: "Are there an infinite number of prime numbers such that n mod 4 == 3?"
107 }
108 ]
109109 });
110110
111111 // The response contains summarized thinking blocks and text blocks
build-with-claude/files Changed · +11 / -16 lines
from line 62
6262
6363 ```typescript TypeScript
6464 const uploaded = await client.files.upload({
65 file: await toFile(
66 fs.createReadStream("/path/to/document.pdf"),
67 undefined,
68 { type: "application/pdf" },
69 ),
65 file: await toFile(fs.createReadStream("/path/to/document.pdf"), undefined, {
66 type: "application/pdf"
67 })
7068 });
7169 console.log(uploaded.id);
7270 ```
from line 241
243241 content: [
244242 {
245243 type: "text",
246 text: "Please summarize this document for me.",
244 text: "Please summarize this document for me."
247245 },
248246 {
249247 type: "document",
250248 source: {
251249 type: "file",
252 file_id: uploaded.id,
253 },
254 },
255 ],
256 },
257 ],
250 file_id: uploaded.id
251 }
252 }
253 ]
254 }
255 ]
258256 });
259257
260258 console.log(response);
from line 529
531529 ]
532530 });
533531
534 const textBlock = response.content.find(
535 (block): block is Anthropic.TextBlock => block.type === "text"
536 );
532 const textBlock = response.content.find((block) => block.type === "text");
537533 console.log(textBlock?.text);
538534 ```
539535
from line 902
906902 _, err = io.Copy(out, resp.Body)
907903 return err
908904 }
909
910905 ```
911906
912907 ```java Java
build-with-claude/handling-stop-reasons Changed · +5 / -15 lines
from line 97
9797
9898 if (response.stop_reason === "end_turn") {
9999 // Process the complete response
100 const textBlock = response.content.find(
101 (block): block is Anthropic.TextBlock => block.type === "text"
102 );
100 const textBlock = response.content.find((block) => block.type === "text");
103101 console.log(textBlock?.text);
104102 }
105103 ```
from line 2101
21032101 return handleRefusal(response);
21042102 default: {
21052103 // Handle end_turn and other cases
2106 const textBlock = response.content.find(
2107 (block): block is Anthropic.Beta.BetaTextBlock => block.type === "text"
2108 );
2104 const textBlock = response.content.find((block) => block.type === "text");
21092105 return textBlock?.text ?? "";
21102106 }
21112107 }
from line 2222
22262222
22272223 ```typescript TypeScript
22282224 function handleTruncatedResponse(response: Anthropic.Beta.BetaMessage): string {
2229 const textBlock = response.content.find(
2230 (block): block is Anthropic.Beta.BetaTextBlock => block.type === "text"
2231 );
2225 const textBlock = response.content.find((block) => block.type === "text");
22322226 const text = textBlock?.text ?? "";
22332227
22342228 if (
from line 3238
32443238 messages
32453239 });
32463240
3247 const textBlock = response.content.find(
3248 (block): block is Anthropic.TextBlock => block.type === "text"
3249 );
3241 const textBlock = response.content.find((block) => block.type === "text");
32503242 fullResponse += textBlock?.text ?? "";
32513243
32523244 if (response.stop_reason !== "max_tokens") {
from line 3494
35023494 console.log(`Generated ${tokens} tokens (natural completion)`);
35033495 }
35043496
3505 const textBlock = response.content.find(
3506 (block): block is Anthropic.Beta.BetaTextBlock => block.type === "text"
3507 );
3497 const textBlock = response.content.find((block) => block.type === "text");
35083498 return textBlock?.text ?? "";
35093499 }
35103500 ```