What this read moved
451–475 of 519This capture is too large to show at once. Changes 451-475 of 519 are below, significant first; the rest are on the following screens.
api/compliance/apps/sessions Changed · +103 / -49 lines
from line 1
1---
2title: Sessions
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions
4---
5
16# Sessions
27
38## Sessions › Local
from line 52
4752
4853#### Headers
4954
55- `"anthropic-version": optional string`
56
57 The version of the Claude API you want to use.
58
59 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
60
5061- `"x-api-key": optional string`
5162
5263#### Returns
from line 66
5566
5667 Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order. `updated_at` never participates in the ordering; the `updated_at.gte` query parameter filters on it without changing the order or the pagination cursor.
5768
69 - `type: "compliance_local_session"`
70
71 default: compliance_local_session
72
5873 - `id: string`
5974
6075 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 88
7388
7489 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
7590
76 - `type: "compliance_local_session"`
91 - `truncated: boolean`
7792
78 default: compliance_local_session
93 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
7994
95 default: false
96
8097 - `updated_at: string`
8198
8299 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 166
149166
150167#### Headers
151168
169- `"anthropic-version": optional string`
170
171 The version of the Claude API you want to use.
172
173 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
174
152175- `"x-api-key": optional string`
153176
154177#### Returns
155178
179- `type: "compliance_local_session"`
180
181 default: compliance_local_session
182
156183- `id: string`
157184
158185 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 198
171198
172199 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
173200
174- `type: "compliance_local_session"`
201- `truncated: boolean`
175202
176 default: compliance_local_session
203 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
177204
205 default: false
206
178207- `updated_at: string`
179208
180209 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 307
278307
279308#### Headers
280309
310- `"anthropic-version": optional string`
311
312 The version of the Claude API you want to use.
313
314 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
315
281316- `"x-api-key": optional string`
282317
283318#### Returns
from line 321
286321
287322 Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
288323
324 - `type: "compliance_local_session_message"`
325
326 default: compliance_local_session_message
327
289328 - `id: string`
290329
291330 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 337
298337
299338 Text content block.
300339
340 - `type: "text"`
341
342 default: text
343
301344 - `text: string`
302345
303346 Text content from the user or the assistant
from line 351
308351
309352 default: false
310353
311 - `type: "text"`
312
313 default: text
314
315354 - `ToolUse object`
316355
317356 Tool invocation requested by the assistant.
318357
358 - `type: "tool_use"`
359
360 default: tool_use
361
319362 - `id: string or null`
320363
321364 Tool-use ID, e.g. 'toolu_01AbC...'
from line 377
334377
335378 default: false
336379
337 - `type: "tool_use"`
338
339 default: tool_use
340
341380 - `ToolResult object`
342381
343382 Result returned by a tool invocation.
344383
384 - `type: "tool_result"`
385
386 default: tool_result
387
345388 - `content: array of object`
346389
347390 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
348391
349 - `text: string`
350
351 Text returned by the tool
352
353392 - `type: "text"`
354393
355394 default: text
356395
396 - `text: string`
397
398 Text returned by the tool
399
357400 - `is_error: boolean`
358401
359402 True when the tool reported an error
from line 415
372415
373416 default: false
374417
375 - `type: "tool_result"`
376
377 default: tool_result
378
379418 - `created_at: string`
380419
381420 When the message was recorded (RFC 3339, UTC)
from line 433
394433
395434 The turn's content cannot be returned; `content` is empty.
396435
397 - `reason: string`
398
399 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
400
401436 - `type: "content_unavailable"`
402437
403438 default: content_unavailable
404439
440 - `reason: string`
441
442 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
443
405444 - `ClientAsserted object`
406445
407446 Assistant content the client supplied as conversation history
from line 477
438477
439478 - `"user"`
440479
441 - `type: "compliance_local_session_message"`
442
443 default: compliance_local_session_message
444
445480- `next_page: string or null`
446481
447482 Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
from line 485
450485
451486 The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
452487
488 - `type: "compliance_local_session"`
489
490 default: compliance_local_session
491
453492 - `id: string`
454493
455494 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 507
468507
469508 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
470509
471 - `type: "compliance_local_session"`
510 - `truncated: boolean`
472511
473 default: compliance_local_session
512 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
474513
514 default: false
515
475516 - `updated_at: string`
476517
477518 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 572
531572 "created_at": "2025-03-12T18:22:41.123456Z",
532573 "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
533574 "product_surface": "cowork",
575 "truncated": true,
534576 "type": "compliance_local_session",
535577 "updated_at": "2025-03-12T18:22:41.123456Z",
536578 "user": {
from line 660
618660
619661#### Headers
620662
663- `"anthropic-version": optional string`
664
665 The version of the Claude API you want to use.
666
667 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
668
621669- `"x-api-key": optional string`
622670
623671#### Returns
from line 835
787835
788836#### Headers
789837
838- `"anthropic-version": optional string`
839
840 The version of the Claude API you want to use.
841
842 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
843
790844- `"x-api-key": optional string`
791845
792846#### Returns
from line 861
807861
808862 Text content block.
809863
864 - `type: "text"`
865
866 default: text
867
810868 - `text: string`
811869
812870 Text content from the user or the assistant
from line 875
817875
818876 default: false
819877
820 - `type: "text"`
821
822 default: text
823
824878 - `ToolUse object`
825879
826880 Tool invocation requested by the assistant.
827881
882 - `type: "tool_use"`
883
884 default: tool_use
885
828886 - `id: string or null`
829887
830888 Tool-use ID, e.g. 'toolu_01AbC...'
from line 901
843901
844902 default: false
845903
846 - `type: "tool_use"`
847
848 default: tool_use
849
850904 - `ToolResult object`
851905
852906 Result returned by a tool invocation.
853907
908 - `type: "tool_result"`
909
910 default: tool_result
911
854912 - `content: array of object`
855913
856914 Text content returned by the tool. Non-text item types are omitted.
857915
858 - `text: string`
859
860 Text returned by the tool
861
862916 - `type: "text"`
863917
864918 default: text
865919
920 - `text: string`
921
922 Text returned by the tool
923
866924 - `is_error: boolean`
867925
868926 True when the tool reported an error
from line 938
880938 True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
881939
882940 default: false
883
884 - `type: "tool_result"`
885
886 default: tool_result
887941
888942 - `content_unavailable: boolean`
889943
api/compliance/apps/sessions/local Changed · +93 / -39 lines
from line 1
1---
2title: Local
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local
4---
5
16# Local
27
38## List local sessions
from line 50
4550
4651### Headers
4752
53- `"anthropic-version": optional string`
54
55 The version of the Claude API you want to use.
56
57 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
58
4859- `"x-api-key": optional string`
4960
5061### Returns
from line 64
5364
5465 Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order. `updated_at` never participates in the ordering; the `updated_at.gte` query parameter filters on it without changing the order or the pagination cursor.
5566
67 - `type: "compliance_local_session"`
68
69 default: compliance_local_session
70
5671 - `id: string`
5772
5873 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 86
7186
7287 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
7388
74 - `type: "compliance_local_session"`
89 - `truncated: boolean`
7590
76 default: compliance_local_session
91 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
7792
93 default: false
94
7895 - `updated_at: string`
7996
8097 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 164
147164
148165### Headers
149166
167- `"anthropic-version": optional string`
168
169 The version of the Claude API you want to use.
170
171 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
172
150173- `"x-api-key": optional string`
151174
152175### Returns
153176
177- `type: "compliance_local_session"`
178
179 default: compliance_local_session
180
154181- `id: string`
155182
156183 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 196
169196
170197 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
171198
172- `type: "compliance_local_session"`
199- `truncated: boolean`
173200
174 default: compliance_local_session
201 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
175202
203 default: false
204
176205- `updated_at: string`
177206
178207 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 258
229258 A session that a user ran on their own computer in a Claude app while
230259 signed in with their organization account.
231260
261 - `type: "compliance_local_session"`
262
263 default: compliance_local_session
264
232265 - `id: string`
233266
234267 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 280
247280
248281 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
249282
250 - `type: "compliance_local_session"`
283 - `truncated: boolean`
251284
252 default: compliance_local_session
285 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
253286
287 default: false
288
254289 - `updated_at: string`
255290
256291 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 315
280315 A session that a user ran on their own computer in a Claude app while
281316 signed in with their organization account.
282317
318 - `type: "compliance_local_session"`
319
320 default: compliance_local_session
321
283322 - `id: string`
284323
285324 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 337
298337
299338 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
300339
301 - `type: "compliance_local_session"`
340 - `truncated: boolean`
302341
303 default: compliance_local_session
342 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
304343
344 default: false
345
305346 - `updated_at: string`
306347
307348 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 421
380421
381422#### Headers
382423
424- `"anthropic-version": optional string`
425
426 The version of the Claude API you want to use.
427
428 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
429
383430- `"x-api-key": optional string`
384431
385432#### Returns
from line 435
388435
389436 Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
390437
438 - `type: "compliance_local_session_message"`
439
440 default: compliance_local_session_message
441
391442 - `id: string`
392443
393444 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 451
400451
401452 Text content block.
402453
454 - `type: "text"`
455
456 default: text
457
403458 - `text: string`
404459
405460 Text content from the user or the assistant
from line 465
410465
411466 default: false
412467
413 - `type: "text"`
414
415 default: text
416
417468 - `ToolUse object`
418469
419470 Tool invocation requested by the assistant.
420471
472 - `type: "tool_use"`
473
474 default: tool_use
475
421476 - `id: string or null`
422477
423478 Tool-use ID, e.g. 'toolu_01AbC...'
from line 491
436491
437492 default: false
438493
439 - `type: "tool_use"`
440
441 default: tool_use
442
443494 - `ToolResult object`
444495
445496 Result returned by a tool invocation.
446497
498 - `type: "tool_result"`
499
500 default: tool_result
501
447502 - `content: array of object`
448503
449504 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
450505
451 - `text: string`
452
453 Text returned by the tool
454
455506 - `type: "text"`
456507
457508 default: text
458509
510 - `text: string`
511
512 Text returned by the tool
513
459514 - `is_error: boolean`
460515
461516 True when the tool reported an error
from line 529
474529
475530 default: false
476531
477 - `type: "tool_result"`
478
479 default: tool_result
480
481532 - `created_at: string`
482533
483534 When the message was recorded (RFC 3339, UTC)
from line 547
496547
497548 The turn's content cannot be returned; `content` is empty.
498549
499 - `reason: string`
500
501 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
502
503550 - `type: "content_unavailable"`
504551
505552 default: content_unavailable
506553
554 - `reason: string`
555
556 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
557
507558 - `ClientAsserted object`
508559
509560 Assistant content the client supplied as conversation history
from line 591
540591
541592 - `"user"`
542593
543 - `type: "compliance_local_session_message"`
544
545 default: compliance_local_session_message
546
547594- `next_page: string or null`
548595
549596 Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
from line 599
552599
553600 The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
554601
602 - `type: "compliance_local_session"`
603
604 default: compliance_local_session
605
555606 - `id: string`
556607
557608 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 621
570621
571622 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
572623
573 - `type: "compliance_local_session"`
624 - `truncated: boolean`
574625
575 default: compliance_local_session
626 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
576627
628 default: false
629
577630 - `updated_at: string`
578631
579632 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 686
633686 "created_at": "2025-03-12T18:22:41.123456Z",
634687 "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
635688 "product_surface": "cowork",
689 "truncated": true,
636690 "type": "compliance_local_session",
637691 "updated_at": "2025-03-12T18:22:41.123456Z",
638692 "user": {
api/compliance/apps/sessions/local/list Changed · +19 / -2 lines
from line 1
1---
2title: List local sessions
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/list
4---
5
16# List local sessions
27
38**GET** `/v1/compliance/apps/sessions/local`
from line 48
4348
4449## Headers
4550
51- `"anthropic-version": optional string`
52
53 The version of the Claude API you want to use.
54
55 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
56
4657- `"x-api-key": optional string`
4758
4859## Returns
from line 62
5162
5263 Page of local sessions, ordered by `created_at` descending; ties are broken by a fixed server-side order. `updated_at` never participates in the ordering; the `updated_at.gte` query parameter filters on it without changing the order or the pagination cursor.
5364
65 - `type: "compliance_local_session"`
66
67 default: compliance_local_session
68
5469 - `id: string`
5570
5671 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 84
6984
7085 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
7186
72 - `type: "compliance_local_session"`
87 - `truncated: boolean`
7388
74 default: compliance_local_session
89 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
90
91 default: false
7592
7693 - `updated_at: string`
7794
api/compliance/apps/sessions/local/messages Changed · +69 / -51 lines
from line 1
1---
2title: Messages
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages
4---
5
16# Messages
27
38## Retrieve local session messages
from line 59
5459
5560### Headers
5661
62- `"anthropic-version": optional string`
63
64 The version of the Claude API you want to use.
65
66 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
67
5768- `"x-api-key": optional string`
5869
5970### Returns
from line 73
6273
6374 Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
6475
76 - `type: "compliance_local_session_message"`
77
78 default: compliance_local_session_message
79
6580 - `id: string`
6681
6782 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 89
7489
7590 Text content block.
7691
92 - `type: "text"`
93
94 default: text
95
7796 - `text: string`
7897
7998 Text content from the user or the assistant
from line 103
84103
85104 default: false
86105
87 - `type: "text"`
88
89 default: text
90
91106 - `ToolUse object`
92107
93108 Tool invocation requested by the assistant.
94109
110 - `type: "tool_use"`
111
112 default: tool_use
113
95114 - `id: string or null`
96115
97116 Tool-use ID, e.g. 'toolu_01AbC...'
from line 129
110129
111130 default: false
112131
113 - `type: "tool_use"`
114
115 default: tool_use
116
117132 - `ToolResult object`
118133
119134 Result returned by a tool invocation.
120135
136 - `type: "tool_result"`
137
138 default: tool_result
139
121140 - `content: array of object`
122141
123142 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
124143
125 - `text: string`
126
127 Text returned by the tool
128
129144 - `type: "text"`
130145
131146 default: text
132147
148 - `text: string`
149
150 Text returned by the tool
151
133152 - `is_error: boolean`
134153
135154 True when the tool reported an error
from line 167
148167
149168 default: false
150169
151 - `type: "tool_result"`
152
153 default: tool_result
154
155170 - `created_at: string`
156171
157172 When the message was recorded (RFC 3339, UTC)
from line 185
170185
171186 The turn's content cannot be returned; `content` is empty.
172187
173 - `reason: string`
174
175 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
176
177188 - `type: "content_unavailable"`
178189
179190 default: content_unavailable
180191
192 - `reason: string`
193
194 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
195
181196 - `ClientAsserted object`
182197
183198 Assistant content the client supplied as conversation history
from line 229
214229
215230 - `"user"`
216231
217 - `type: "compliance_local_session_message"`
218
219 default: compliance_local_session_message
220
221232- `next_page: string or null`
222233
223234 Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
from line 237
226237
227238 The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
228239
240 - `type: "compliance_local_session"`
241
242 default: compliance_local_session
243
229244 - `id: string`
230245
231246 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 259
244259
245260 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
246261
247 - `type: "compliance_local_session"`
262 - `truncated: boolean`
248263
249 default: compliance_local_session
264 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
250265
266 default: false
267
251268 - `updated_at: string`
252269
253270 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 324
307324 "created_at": "2025-03-12T18:22:41.123456Z",
308325 "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
309326 "product_surface": "cowork",
327 "truncated": true,
310328 "type": "compliance_local_session",
311329 "updated_at": "2025-03-12T18:22:41.123456Z",
312330 "user": {
from line 344
326344
327345 A single user or assistant turn in a local session transcript.
328346
347 - `type: "compliance_local_session_message"`
348
349 default: compliance_local_session_message
350
329351 - `id: string`
330352
331353 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 360
338360
339361 Text content block.
340362
363 - `type: "text"`
364
365 default: text
366
341367 - `text: string`
342368
343369 Text content from the user or the assistant
from line 374
348374
349375 default: false
350376
351 - `type: "text"`
352
353 default: text
354
355377 - `ToolUse object`
356378
357379 Tool invocation requested by the assistant.
358380
381 - `type: "tool_use"`
382
383 default: tool_use
384
359385 - `id: string or null`
360386
361387 Tool-use ID, e.g. 'toolu_01AbC...'
from line 400
374400
375401 default: false
376402
377 - `type: "tool_use"`
378
379 default: tool_use
380
381403 - `ToolResult object`
382404
383405 Result returned by a tool invocation.
384406
407 - `type: "tool_result"`
408
409 default: tool_result
410
385411 - `content: array of object`
386412
387413 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
388414
389 - `text: string`
390
391 Text returned by the tool
392
393415 - `type: "text"`
394416
395417 default: text
396418
419 - `text: string`
420
421 Text returned by the tool
422
397423 - `is_error: boolean`
398424
399425 True when the tool reported an error
from line 438
412438
413439 default: false
414440
415 - `type: "tool_result"`
416
417 default: tool_result
418
419441 - `created_at: string`
420442
421443 When the message was recorded (RFC 3339, UTC)
from line 456
434456
435457 The turn's content cannot be returned; `content` is empty.
436458
437 - `reason: string`
438
439 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
440
441459 - `type: "content_unavailable"`
442460
443461 default: content_unavailable
444462
463 - `reason: string`
464
465 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
466
445467 - `ClientAsserted object`
446468
447469 Assistant content the client supplied as conversation history
from line 499
477499 - `"assistant"`
478500
479501 - `"user"`
480
481 - `type: "compliance_local_session_message"`
482
483 default: compliance_local_session_message
484502
api/compliance/apps/sessions/local/messages/list Changed · +45 / -27 lines
from line 1
1---
2title: Retrieve local session messages
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/messages/list
4---
5
16# Retrieve local session messages
27
38**GET** `/v1/compliance/apps/sessions/local/{local_session_id}/messages`
from line 57
5257
5358## Headers
5459
60- `"anthropic-version": optional string`
61
62 The version of the Claude API you want to use.
63
64 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
65
5566- `"x-api-key": optional string`
5667
5768## Returns
from line 71
6071
6172 Transcript turns for this page, in call order: oldest call first by default, newest call first with `order=desc`. The messages of one call carry the call's timestamp and follow each other in transcript order; a page boundary can fall between them.
6273
74 - `type: "compliance_local_session_message"`
75
76 default: compliance_local_session_message
77
6378 - `id: string`
6479
6580 Message identifier, prefixed `clsm_`. Stable for as long as the message's turn is retained: identifiers of retained turns do not change as older turns age out of the organization's retention period. The `retention_elapsed` placeholder's identifier is distinct from every retained turn's and changes only when further turns age out.
from line 87
7287
7388 Text content block.
7489
90 - `type: "text"`
91
92 default: text
93
7594 - `text: string`
7695
7796 Text content from the user or the assistant
from line 101
82101
83102 default: false
84103
85 - `type: "text"`
86
87 default: text
88
89104 - `ToolUse object`
90105
91106 Tool invocation requested by the assistant.
92107
108 - `type: "tool_use"`
109
110 default: tool_use
111
93112 - `id: string or null`
94113
95114 Tool-use ID, e.g. 'toolu_01AbC...'
from line 127
108127
109128 default: false
110129
111 - `type: "tool_use"`
112
113 default: tool_use
114
115130 - `ToolResult object`
116131
117132 Result returned by a tool invocation.
118133
134 - `type: "tool_result"`
135
136 default: tool_result
137
119138 - `content: array of object`
120139
121140 Text content returned by the tool. Non-text item types are omitted and signalled via `truncated` with an in-band item-count marker.
122141
123 - `text: string`
124
125 Text returned by the tool
126
127142 - `type: "text"`
128143
129144 default: text
130145
146 - `text: string`
147
148 Text returned by the tool
149
131150 - `is_error: boolean`
132151
133152 True when the tool reported an error
from line 165
146165
147166 default: false
148167
149 - `type: "tool_result"`
150
151 default: tool_result
152
153168 - `created_at: string`
154169
155170 When the message was recorded (RFC 3339, UTC)
from line 183
168183
169184 The turn's content cannot be returned; `content` is empty.
170185
171 - `reason: string`
172
173 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
174
175186 - `type: "content_unavailable"`
176187
177188 default: content_unavailable
178189
190 - `reason: string`
191
192 Why this turn's content cannot be returned, e.g. `not_captured` (the content was not captured for compliance retrieval), `client_aborted` (the client closed the connection or cancelled the request before the response completed, so the response was not captured for this turn; any partial output already streamed to the client is not included; assistant-role turns only), `cmek_key_revoked` (the content is encrypted under the organization's customer-managed key and that key is unavailable), `retention_elapsed` (the content lies past the organization's retention boundary; on the placeholder standing in for every pre-boundary turn), or `oversize` (the message exceeds the server's per-message size bound even after per-block truncation). Callers should tolerate unrecognized values. `not_captured` is not proof that no record was stored: content withheld by the storage layer's fail-closed access policies carries the same reason and is deliberately indistinguishable from content that was never captured.
193
179194 - `ClientAsserted object`
180195
181196 Assistant content the client supplied as conversation history
from line 227
212227
213228 - `"user"`
214229
215 - `type: "compliance_local_session_message"`
216
217 default: compliance_local_session_message
218
219230- `next_page: string or null`
220231
221232 Opaque pagination cursor (prefixed `page_`) for the next page. Null when there is no further page. Treat as an opaque string; the format may change without notice.
from line 235
224235
225236 The local session the messages belong to. `user.email_address` is always null on this endpoint; the messages endpoint does not resolve email addresses.
226237
238 - `type: "compliance_local_session"`
239
240 default: compliance_local_session
241
227242 - `id: string`
228243
229244 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 257
242257
243258 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
244259
245 - `type: "compliance_local_session"`
260 - `truncated: boolean`
246261
247 default: compliance_local_session
262 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
248263
264 default: false
265
249266 - `updated_at: string`
250267
251268 Timestamp of the session's last retained inference call (RFC 3339, UTC). Always at or after `created_at`. When a session's activity spans the child organization's retention boundary, calls older than the boundary are no longer reflected — but because retention removes only the oldest calls, this value (unlike `created_at`) is unaffected until the entire session has aged out. On the list endpoint this value is a lower bound: for a session still active at a page or `created_at.lt` window boundary it can momentarily lag the session's true last activity. Retrieving the session, or its messages, always reflects the exact latest retained call.
from line 322
305322 "created_at": "2025-03-12T18:22:41.123456Z",
306323 "organization_uuid": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
307324 "product_surface": "cowork",
325 "truncated": true,
308326 "type": "compliance_local_session",
309327 "updated_at": "2025-03-12T18:22:41.123456Z",
310328 "user": {
api/compliance/apps/sessions/local/retrieve Changed · +19 / -2 lines
from line 1
1---
2title: Retrieve a local session
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/local/retrieve
4---
5
16# Retrieve a local session
27
38**GET** `/v1/compliance/apps/sessions/local/{local_session_id}`
from line 20
1520
1621## Headers
1722
23- `"anthropic-version": optional string`
24
25 The version of the Claude API you want to use.
26
27 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
28
1829- `"x-api-key": optional string`
1930
2031## Returns
2132
33- `type: "compliance_local_session"`
34
35 default: compliance_local_session
36
2237- `id: string`
2338
2439 Local session identifier, prefixed `clls_`. Unique within the parent organization. Treat as an opaque string; the format may change without notice.
from line 52
3752
3853 The product the session ran in: `cowork` (Cowork in Claude Desktop on the user's machine), `claude_code` (Claude Code), `claude_science` (Claude Science), or one of `office_agents/excel`, `office_agents/powerpoint`, `office_agents/word`, and `office_agents/outlook` (Claude for Microsoft 365, by app; `office_agents` alone when the app is not identified). New values appear as coverage expands; treat unrecognized values as opaque. `null` when the surface was not recorded.
3954
40- `type: "compliance_local_session"`
55- `truncated: boolean`
4156
42 default: compliance_local_session
57 True when the session has more inference calls than the service can return for one session (100,000). The messages endpoint then returns only the session's earliest calls, up to that many, and ends before the session does; `updated_at` is a lower bound on the latest call and can differ between the list and retrieve endpoints. False for every session within that bound.
58
59 default: false
4360
4461- `updated_at: string`
4562
api/compliance/apps/sessions/remote Changed · +33 / -16 lines
from line 1
1---
2title: Remote
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote
4---
5
16# Remote
27
38## List remote sessions
from line 79
7479
7580### Headers
7681
82- `"anthropic-version": optional string`
83
84 The version of the Claude API you want to use.
85
86 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
87
7788- `"x-api-key": optional string`
7889
7990### Returns
from line 326
315326
316327#### Headers
317328
329- `"anthropic-version": optional string`
330
331 The version of the Claude API you want to use.
332
333 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
334
318335- `"x-api-key": optional string`
319336
320337#### Returns
from line 352
335352
336353 Text content block.
337354
355 - `type: "text"`
356
357 default: text
358
338359 - `text: string`
339360
340361 Text content from the user or the assistant
from line 366
345366
346367 default: false
347368
348 - `type: "text"`
349
350 default: text
351
352369 - `ToolUse object`
353370
354371 Tool invocation requested by the assistant.
355372
373 - `type: "tool_use"`
374
375 default: tool_use
376
356377 - `id: string or null`
357378
358379 Tool-use ID, e.g. 'toolu_01AbC...'
from line 392
371392
372393 default: false
373394
374 - `type: "tool_use"`
375
376 default: tool_use
377
378395 - `ToolResult object`
379396
380397 Result returned by a tool invocation.
381398
399 - `type: "tool_result"`
400
401 default: tool_result
402
382403 - `content: array of object`
383404
384405 Text content returned by the tool. Non-text item types are omitted.
385406
386 - `text: string`
387
388 Text returned by the tool
389
390407 - `type: "text"`
391408
392409 default: text
393410
411 - `text: string`
412
413 Text returned by the tool
414
394415 - `is_error: boolean`
395416
396417 True when the tool reported an error
from line 429
408429 True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
409430
410431 default: false
411
412 - `type: "tool_result"`
413
414 default: tool_result
415432
416433 - `content_unavailable: boolean`
417434
api/compliance/apps/sessions/remote/list Changed · +11 / -0 lines
from line 1
1---
2title: List remote sessions
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/list
4---
5
16# List remote sessions
27
38**GET** `/v1/compliance/apps/sessions/remote`
from line 76
7176 maxItems: 10
7277
7378## Headers
79
80- `"anthropic-version": optional string`
81
82 The version of the Claude API you want to use.
83
84 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7485
7586- `"x-api-key": optional string`
7687
api/compliance/apps/sessions/remote/messages Changed · +43 / -32 lines
from line 1
1---
2title: Messages
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages
4---
5
16# Messages
27
38## Retrieve remote session messages
from line 72
6772
6873### Headers
6974
75- `"anthropic-version": optional string`
76
77 The version of the Claude API you want to use.
78
79 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
80
7081- `"x-api-key": optional string`
7182
7283### Returns
from line 98
8798
8899 Text content block.
89100
101 - `type: "text"`
102
103 default: text
104
90105 - `text: string`
91106
92107 Text content from the user or the assistant
from line 112
97112
98113 default: false
99114
100 - `type: "text"`
101
102 default: text
103
104115 - `ToolUse object`
105116
106117 Tool invocation requested by the assistant.
107118
119 - `type: "tool_use"`
120
121 default: tool_use
122
108123 - `id: string or null`
109124
110125 Tool-use ID, e.g. 'toolu_01AbC...'
from line 138
123138
124139 default: false
125140
126 - `type: "tool_use"`
127
128 default: tool_use
129
130141 - `ToolResult object`
131142
132143 Result returned by a tool invocation.
133144
145 - `type: "tool_result"`
146
147 default: tool_result
148
134149 - `content: array of object`
135150
136151 Text content returned by the tool. Non-text item types are omitted.
137152
138 - `text: string`
139
140 Text returned by the tool
141
142153 - `type: "text"`
143154
144155 default: text
145156
157 - `text: string`
158
159 Text returned by the tool
160
146161 - `is_error: boolean`
147162
148163 True when the tool reported an error
from line 176
161176
162177 default: false
163178
164 - `type: "tool_result"`
165
166 default: tool_result
167
168179 - `content_unavailable: boolean`
169180
170181 True when the stored content could not be returned — it could not be decrypted, or it exceeded the server's per-event size bound. `content` is empty in that case; this distinguishes 'no content' from 'content withheld'.
from line 340
329340
330341 Text content block.
331342
343 - `type: "text"`
344
345 default: text
346
332347 - `text: string`
333348
334349 Text content from the user or the assistant
from line 354
339354
340355 default: false
341356
342 - `type: "text"`
343
344 default: text
345
346357 - `ToolUse object`
347358
348359 Tool invocation requested by the assistant.
349360
361 - `type: "tool_use"`
362
363 default: tool_use
364
350365 - `id: string or null`
351366
352367 Tool-use ID, e.g. 'toolu_01AbC...'
from line 380
365380
366381 default: false
367382
368 - `type: "tool_use"`
369
370 default: tool_use
371
372383 - `ToolResult object`
373384
374385 Result returned by a tool invocation.
375386
387 - `type: "tool_result"`
388
389 default: tool_result
390
376391 - `content: array of object`
377392
378393 Text content returned by the tool. Non-text item types are omitted.
379394
380 - `text: string`
381
382 Text returned by the tool
383
384395 - `type: "text"`
385396
386397 default: text
387398
399 - `text: string`
400
401 Text returned by the tool
402
388403 - `is_error: boolean`
389404
390405 True when the tool reported an error
from line 417
402417 True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
403418
404419 default: false
405
406 - `type: "tool_result"`
407
408 default: tool_result
409420
410421 - `content_unavailable: boolean`
411422
api/compliance/apps/sessions/remote/messages/list Changed · +27 / -16 lines
from line 1
1---
2title: Retrieve remote session messages
3url: https://platform.claude.com/docs/en/api/compliance/apps/sessions/remote/messages/list
4---
5
16# Retrieve remote session messages
27
38**GET** `/v1/compliance/apps/sessions/remote/{claude_remote_session_id}/messages`
from line 70
6570
6671## Headers
6772
73- `"anthropic-version": optional string`
74
75 The version of the Claude API you want to use.
76
77 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
78
6879- `"x-api-key": optional string`
6980
7081## Returns
from line 96
8596
8697 Text content block.
8798
99 - `type: "text"`
100
101 default: text
102
88103 - `text: string`
89104
90105 Text content from the user or the assistant
from line 110
95110
96111 default: false
97112
98 - `type: "text"`
99
100 default: text
101
102113 - `ToolUse object`
103114
104115 Tool invocation requested by the assistant.
105116
117 - `type: "tool_use"`
118
119 default: tool_use
120
106121 - `id: string or null`
107122
108123 Tool-use ID, e.g. 'toolu_01AbC...'
from line 136
121136
122137 default: false
123138
124 - `type: "tool_use"`
125
126 default: tool_use
127
128139 - `ToolResult object`
129140
130141 Result returned by a tool invocation.
131142
143 - `type: "tool_result"`
144
145 default: tool_result
146
132147 - `content: array of object`
133148
134149 Text content returned by the tool. Non-text item types are omitted.
135150
136 - `text: string`
137
138 Text returned by the tool
139
140151 - `type: "text"`
141152
142153 default: text
143154
155 - `text: string`
156
157 Text returned by the tool
158
144159 - `is_error: boolean`
145160
146161 True when the tool reported an error
from line 173
158173 True when one or more text items in `content` were shortened. Pass `tool_result_max_bytes=-1` to request full content, subject to the server-side maximum.
159174
160175 default: false
161
162 - `type: "tool_result"`
163
164 default: tool_result
165176
166177 - `content_unavailable: boolean`
167178
api/compliance/code Changed · +29 / -6 lines
from line 1
1---
2title: Code
3url: https://platform.claude.com/docs/en/api/compliance/code
4---
5
16# Code
27
38## Code › Artifacts
from line 76
7176
7277#### Headers
7378
79- `"anthropic-version": optional string`
80
81 The version of the Claude API you want to use.
82
83 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
84
7485- `"x-api-key": optional string`
7586
7687#### Returns
from line 233
222233
223234#### Headers
224235
236- `"anthropic-version": optional string`
237
238 The version of the Claude API you want to use.
239
240 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
241
225242- `"x-api-key": optional string`
226243
227244#### Example
from line 269
252269
253270#### Headers
254271
255- `"x-api-key": optional string`
272- `"anthropic-version": optional string`
256273
257#### Returns
274 The version of the Claude API you want to use.
258275
259- `id: string`
276 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
260277
261 The ID of the Artifact that was deleted
278- `"x-api-key": optional string`
262279
280#### Returns
281
263282- `type: "code_artifact_deleted"`
264283
265284 Constant string confirming deletion
266285
267286 default: code_artifact_deleted
287
288- `id: string`
289
290 The ID of the Artifact that was deleted
268291
269292#### Example
270293
api/compliance/code/artifacts Changed · +35 / -12 lines
from line 1
1---
2title: Artifacts
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts
4---
5
16# Artifacts
27
38## List Code Artifacts
from line 74
6974
7075### Headers
7176
77- `"anthropic-version": optional string`
78
79 The version of the Claude API you want to use.
80
81 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
82
7283- `"x-api-key": optional string`
7384
7485### Returns
from line 231
220231
221232### Headers
222233
234- `"anthropic-version": optional string`
235
236 The version of the Claude API you want to use.
237
238 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
239
223240- `"x-api-key": optional string`
224241
225242### Example
from line 267
250267
251268### Headers
252269
253- `"x-api-key": optional string`
270- `"anthropic-version": optional string`
254271
255### Returns
272 The version of the Claude API you want to use.
256273
257- `id: string`
274 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
258275
259 The ID of the Artifact that was deleted
276- `"x-api-key": optional string`
260277
278### Returns
279
261280- `type: "code_artifact_deleted"`
262281
263282 Constant string confirming deletion
from line 283
264283
265284 default: code_artifact_deleted
266285
286- `id: string`
287
288 The ID of the Artifact that was deleted
289
267290### Example
268291
269292```bash
from line 387
364387
365388 Response for deleting a Code Artifact.
366389
367 - `id: string`
368
369 The ID of the Artifact that was deleted
370
371390 - `type: "code_artifact_deleted"`
372391
373392 Constant string confirming deletion
374393
375394 default: code_artifact_deleted
395
396 - `id: string`
397
398 The ID of the Artifact that was deleted
376399
api/compliance/code/artifacts/delete Changed · +15 / -4 lines
from line 1
1---
2title: Delete Code Artifact
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/delete
4---
5
16# Delete Code Artifact
27
38**DELETE** `/v1/compliance/apps/code/artifacts/{artifact_id}`
from line 24
1924
2025## Headers
2126
22- `"x-api-key": optional string`
27- `"anthropic-version": optional string`
2328
24## Returns
29 The version of the Claude API you want to use.
2530
26- `id: string`
31 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2732
28 The ID of the Artifact that was deleted
33- `"x-api-key": optional string`
2934
35## Returns
36
3037- `type: "code_artifact_deleted"`
3138
3239 Constant string confirming deletion
3340
3441 default: code_artifact_deleted
42
43- `id: string`
44
45 The ID of the Artifact that was deleted
3546
3647## Example
3748
api/compliance/code/artifacts/list Changed · +11 / -0 lines
from line 1
1---
2title: List Code Artifacts
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/list
4---
5
16# List Code Artifacts
27
38**GET** `/v1/compliance/apps/code/artifacts`
from line 71
6671 maxItems: 200
6772
6873## Headers
74
75- `"anthropic-version": optional string`
76
77 The version of the Claude API you want to use.
78
79 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6980
7081- `"x-api-key": optional string`
7182
api/compliance/code/artifacts/retrieve_version Changed · +11 / -0 lines
from line 1
1---
2title: Download Code Artifact Version Content
3url: https://platform.claude.com/docs/en/api/compliance/code/artifacts/retrieve_version
4---
5
16# Download Code Artifact Version Content
27
38**GET** `/v1/compliance/apps/code/artifacts/{artifact_id}/versions/{version_id}`
from line 31
2631 Opaque version identifier from the Artifact's `versions` list
2732
2833## Headers
34
35- `"anthropic-version": optional string`
36
37 The version of the Claude API you want to use.
38
39 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2940
3041- `"x-api-key": optional string`
3142
api/compliance/groups Changed · +59 / -16 lines
from line 1
1---
2title: Groups
3url: https://platform.claude.com/docs/en/api/compliance/groups
4---
5
16# Groups
27
38## List Compliance Groups
from line 31
2631
2732### Headers
2833
34- `"anthropic-version": optional string`
35
36 The version of the Claude API you want to use.
37
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
39
2940- `"x-api-key": optional string`
3041
3142### Returns
from line 51
4051
4152 - `created_at: string or null`
4253
43 Group creation timestamp (ISO 8601)
54 Group creation timestamp (RFC 3339)
4455
56 format: date-time
57
4558 - `description: string`
4659
4760 Group description
from line 73
6073
6174 - `updated_at: string or null`
6275
63 Group last-updated timestamp (ISO 8601)
76 Group last-updated timestamp (RFC 3339)
6477
78 format: date-time
79
6580- `has_more: boolean`
6681
6782 Whether more records exist beyond the current result set
from line 99
8499 "data": [
85100 {
86101 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
87 "created_at": "2025-03-12T18:22:41.123456",
102 "created_at": "2025-03-12T18:22:41.123456Z",
88103 "description": "All members of the engineering organization",
89104 "name": "Engineering Team",
90105 "roles": [
from line 107
92107 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
93108 ],
94109 "source_type": "scim",
95 "updated_at": "2025-03-14T09:05:17.456789"
110 "updated_at": "2025-03-14T09:05:17.456789Z"
96111 }
97112 ],
98113 "has_more": true,
from line 129
114129
115130### Headers
116131
132- `"anthropic-version": optional string`
133
134 The version of the Claude API you want to use.
135
136 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
137
117138- `"x-api-key": optional string`
118139
119140### Returns
from line 145
124145
125146- `created_at: string or null`
126147
127 Group creation timestamp (ISO 8601)
148 Group creation timestamp (RFC 3339)
128149
150 format: date-time
151
129152- `description: string`
130153
131154 Group description
from line 167
144167
145168- `updated_at: string or null`
146169
147 Group last-updated timestamp (ISO 8601)
170 Group last-updated timestamp (RFC 3339)
148171
172 format: date-time
173
149174### Example
150175
151176```bash
from line 183
158183```json
159184{
160185 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
161 "created_at": "2025-03-12T18:22:41.123456",
186 "created_at": "2025-03-12T18:22:41.123456Z",
162187 "description": "All members of the engineering organization",
163188 "name": "Engineering Team",
164189 "roles": [
from line 191
166191 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
167192 ],
168193 "source_type": "scim",
169 "updated_at": "2025-03-14T09:05:17.456789"
194 "updated_at": "2025-03-14T09:05:17.456789Z"
170195}
171196```
172197
from line 209
184209
185210 - `created_at: string or null`
186211
187 Group creation timestamp (ISO 8601)
212 Group creation timestamp (RFC 3339)
188213
214 format: date-time
215
189216 - `description: string`
190217
191218 Group description
from line 231
204231
205232 - `updated_at: string or null`
206233
207 Group last-updated timestamp (ISO 8601)
234 Group last-updated timestamp (RFC 3339)
208235
236 format: date-time
237
209238### Group List Response
210239
211240- `GroupListResponse object`
from line 247
218247
219248 - `created_at: string or null`
220249
221 Group creation timestamp (ISO 8601)
250 Group creation timestamp (RFC 3339)
222251
252 format: date-time
253
223254 - `description: string`
224255
225256 Group description
from line 269
238269
239270 - `updated_at: string or null`
240271
241 Group last-updated timestamp (ISO 8601)
272 Group last-updated timestamp (RFC 3339)
242273
274 format: date-time
275
243276## Groups › Members
244277
245278### List Compliance Group Members
from line 301
268301
269302#### Headers
270303
304- `"anthropic-version": optional string`
305
306 The version of the Claude API you want to use.
307
308 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
309
271310- `"x-api-key": optional string`
272311
273312#### Returns
from line 317
278317
279318 - `created_at: string or null`
280319
281 Membership creation timestamp (ISO 8601)
320 Membership creation timestamp (RFC 3339)
282321
322 format: date-time
323
283324 - `email: string`
284325
285326 Member email address
from line 327
286327
287328 - `updated_at: string or null`
288329
289 Membership last-updated timestamp (ISO 8601)
330 Membership last-updated timestamp (RFC 3339)
290331
332 format: date-time
333
291334 - `user_id: string`
292335
293336 Member user identifier (tagged ID)
from line 356
313356{
314357 "data": [
315358 {
316 "created_at": "2025-03-12T18:22:41.123456",
359 "created_at": "2025-03-12T18:22:41.123456Z",
318 "updated_at": "2025-03-14T09:05:17.456789",
361 "updated_at": "2025-03-14T09:05:17.456789Z",
319362 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
320363 }
321364 ],
api/compliance/groups/list Changed · +19 / -4 lines
from line 1
1---
2title: List Compliance Groups
3url: https://platform.claude.com/docs/en/api/compliance/groups/list
4---
5
16# List Compliance Groups
27
38**GET** `/v1/compliance/groups`
from line 29
2429
2530## Headers
2631
32- `"anthropic-version": optional string`
33
34 The version of the Claude API you want to use.
35
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37
2738- `"x-api-key": optional string`
2839
2940## Returns
from line 49
3849
3950 - `created_at: string or null`
4051
41 Group creation timestamp (ISO 8601)
52 Group creation timestamp (RFC 3339)
4253
54 format: date-time
55
4356 - `description: string`
4457
4558 Group description
from line 71
5871
5972 - `updated_at: string or null`
6073
61 Group last-updated timestamp (ISO 8601)
74 Group last-updated timestamp (RFC 3339)
6275
76 format: date-time
77
6378- `has_more: boolean`
6479
6580 Whether more records exist beyond the current result set
from line 97
8297 "data": [
8398 {
8499 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
85 "created_at": "2025-03-12T18:22:41.123456",
100 "created_at": "2025-03-12T18:22:41.123456Z",
86101 "description": "All members of the engineering organization",
87102 "name": "Engineering Team",
88103 "roles": [
from line 105
90105 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
91106 ],
92107 "source_type": "scim",
93 "updated_at": "2025-03-14T09:05:17.456789"
108 "updated_at": "2025-03-14T09:05:17.456789Z"
94109 }
95110 ],
96111 "has_more": true,
api/compliance/groups/members Changed · +25 / -6 lines
from line 1
1---
2title: Members
3url: https://platform.claude.com/docs/en/api/compliance/groups/members
4---
5
16# Members
27
38## List Compliance Group Members
from line 31
2631
2732### Headers
2833
34- `"anthropic-version": optional string`
35
36 The version of the Claude API you want to use.
37
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
39
2940- `"x-api-key": optional string`
3041
3142### Returns
from line 47
3647
3748 - `created_at: string or null`
3849
39 Membership creation timestamp (ISO 8601)
50 Membership creation timestamp (RFC 3339)
4051
52 format: date-time
53
4154 - `email: string`
4255
4356 Member email address
from line 57
4457
4558 - `updated_at: string or null`
4659
47 Membership last-updated timestamp (ISO 8601)
60 Membership last-updated timestamp (RFC 3339)
4861
62 format: date-time
63
4964 - `user_id: string`
5065
5166 Member user identifier (tagged ID)
from line 86
7186{
7287 "data": [
7388 {
74 "created_at": "2025-03-12T18:22:41.123456",
89 "created_at": "2025-03-12T18:22:41.123456Z",
76 "updated_at": "2025-03-14T09:05:17.456789",
91 "updated_at": "2025-03-14T09:05:17.456789Z",
7792 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
7893 }
7994 ],
from line 107
92107
93108 - `created_at: string or null`
94109
95 Membership creation timestamp (ISO 8601)
110 Membership creation timestamp (RFC 3339)
96111
112 format: date-time
113
97114 - `email: string`
98115
99116 Member email address
from line 117
100117
101118 - `updated_at: string or null`
102119
103 Membership last-updated timestamp (ISO 8601)
120 Membership last-updated timestamp (RFC 3339)
121
122 format: date-time
104123
105124 - `user_id: string`
106125
api/compliance/groups/members/list Changed · +19 / -4 lines
from line 1
1---
2title: List Compliance Group Members
3url: https://platform.claude.com/docs/en/api/compliance/groups/members/list
4---
5
16# List Compliance Group Members
27
38**GET** `/v1/compliance/groups/{group_id}/members`
from line 29
2429
2530## Headers
2631
32- `"anthropic-version": optional string`
33
34 The version of the Claude API you want to use.
35
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37
2738- `"x-api-key": optional string`
2839
2940## Returns
from line 45
3445
3546 - `created_at: string or null`
3647
37 Membership creation timestamp (ISO 8601)
48 Membership creation timestamp (RFC 3339)
3849
50 format: date-time
51
3952 - `email: string`
4053
4154 Member email address
from line 55
4255
4356 - `updated_at: string or null`
4457
45 Membership last-updated timestamp (ISO 8601)
58 Membership last-updated timestamp (RFC 3339)
4659
60 format: date-time
61
4762 - `user_id: string`
4863
4964 Member user identifier (tagged ID)
from line 84
6984{
7085 "data": [
7186 {
72 "created_at": "2025-03-12T18:22:41.123456",
87 "created_at": "2025-03-12T18:22:41.123456Z",
74 "updated_at": "2025-03-14T09:05:17.456789",
89 "updated_at": "2025-03-14T09:05:17.456789Z",
7590 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
7691 }
7792 ],
api/compliance/groups/retrieve Changed · +19 / -4 lines
from line 1
1---
2title: Get Compliance Group
3url: https://platform.claude.com/docs/en/api/compliance/groups/retrieve
4---
5
16# Get Compliance Group
27
38**GET** `/v1/compliance/groups/{group_id}`
from line 17
1217
1318## Headers
1419
20- `"anthropic-version": optional string`
21
22 The version of the Claude API you want to use.
23
24 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
25
1526- `"x-api-key": optional string`
1627
1728## Returns
from line 33
2233
2334- `created_at: string or null`
2435
25 Group creation timestamp (ISO 8601)
36 Group creation timestamp (RFC 3339)
2637
38 format: date-time
39
2740- `description: string`
2841
2942 Group description
from line 55
4255
4356- `updated_at: string or null`
4457
45 Group last-updated timestamp (ISO 8601)
58 Group last-updated timestamp (RFC 3339)
4659
60 format: date-time
61
4762## Example
4863
4964```bash
from line 71
5671```json
5772{
5873 "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
59 "created_at": "2025-03-12T18:22:41.123456",
74 "created_at": "2025-03-12T18:22:41.123456Z",
6075 "description": "All members of the engineering organization",
6176 "name": "Engineering Team",
6277 "roles": [
from line 79
6479 "rbac_role_01HtCd4mFoAseWS3RnzKcwE7"
6580 ],
6681 "source_type": "scim",
67 "updated_at": "2025-03-14T09:05:17.456789"
82 "updated_at": "2025-03-14T09:05:17.456789Z"
6883}
6984```
7085
api/compliance/organizations Changed · +96 / -45 lines
from line 1
1---
2title: Organizations
3url: https://platform.claude.com/docs/en/api/compliance/organizations
4---
5
16# Organizations
27
38## List organizations
from line 29
2429
2530### Headers
2631
32- `"anthropic-version": optional string`
33
34 The version of the Claude API you want to use.
35
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37
2738- `"x-api-key": optional string`
2839
2940### Returns
from line 134
123134
124135#### Headers
125136
137- `"anthropic-version": optional string`
138
139 The version of the Claude API you want to use.
140
141 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
142
126143- `"x-api-key": optional string`
127144
128145#### Returns
from line 249
232249
233250#### Headers
234251
252- `"anthropic-version": optional string`
253
254 The version of the Claude API you want to use.
255
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
257
235258- `"x-api-key": optional string`
236259
237260#### Returns
from line 269
246269
247270 - `created_at: string or null`
248271
249 Role creation timestamp (ISO 8601)
272 Role creation timestamp (RFC 3339)
250273
274 format: date-time
275
251276 - `description: string`
252277
253278 Role description
from line 283
258283
259284 - `updated_at: string or null`
260285
261 Role last-updated timestamp (ISO 8601)
286 Role last-updated timestamp (RFC 3339)
262287
288 format: date-time
289
263290- `has_more: boolean`
264291
265292 Whether more records exist beyond the current result set
from line 309
282309 "data": [
283310 {
284311 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
285 "created_at": "2025-03-12T18:22:41.123456",
312 "created_at": "2025-03-12T18:22:41.123456Z",
286313 "description": "Full administrative access to organization settings and members",
287314 "name": "Organization Admin",
288 "updated_at": "2025-03-14T09:05:17.456789"
315 "updated_at": "2025-03-14T09:05:17.456789Z"
289316 }
290317 ],
291318 "has_more": true,
from line 338
311338
312339#### Headers
313340
341- `"anthropic-version": optional string`
342
343 The version of the Claude API you want to use.
344
345 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
346
314347- `"x-api-key": optional string`
315348
316349#### Returns
from line 354
321354
322355- `created_at: string or null`
323356
324 Role creation timestamp (ISO 8601)
357 Role creation timestamp (RFC 3339)
325358
359 format: date-time
360
326361- `description: string`
327362
328363 Role description
from line 368
333368
334369- `updated_at: string or null`
335370
336 Role last-updated timestamp (ISO 8601)
371 Role last-updated timestamp (RFC 3339)
337372
373 format: date-time
374
338375#### Example
339376
340377```bash
from line 384
347384```json
348385{
349386 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
350 "created_at": "2025-03-12T18:22:41.123456",
387 "created_at": "2025-03-12T18:22:41.123456Z",
351388 "description": "Full administrative access to organization settings and members",
352389 "name": "Organization Admin",
353 "updated_at": "2025-03-14T09:05:17.456789"
390 "updated_at": "2025-03-14T09:05:17.456789Z"
354391}
355392```
356393
from line 423
386423
387424#### Headers
388425
426- `"anthropic-version": optional string`
427
428 The version of the Claude API you want to use.
429
430 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
431
389432- `"x-api-key": optional string`
390433
391434#### Returns
from line 505
462505
463506#### Headers
464507
508- `"anthropic-version": optional string`
509
510 The version of the Claude API you want to use.
511
512 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
513
465514- `"x-api-key": optional string`
466515
467516#### Returns
468517
518- `type: optional "effective_organization_settings"`
519
520 default: effective_organization_settings
521
469522- `api_keys: array of object`
470523
471524 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
472525
526 - `type: optional "compliance_api_key"`
527
528 default: compliance_api_key
529
473530 - `id: string`
474531
475532 Unique identifier for the API key.
from line 559
502559
503560 format: date-time
504561
505 - `type: optional "compliance_api_key"`
506
507 default: compliance_api_key
508
509562- `organization_id: string`
510563
511564- `settings: array of object or object or object or 3 more`
from line 567
514567
515568 A setting whose enforced value is a single true/false flag.
516569
517 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
570 - `type: optional "boolean"`
518571
572 default: boolean
573
574 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
575
519576 - `"ai_powered_artifacts_enabled"`
520577
521578 - `"api_workbench_feedback_collection_enabled"`
from line 589
532589
533590 - `"claude_ai_integration_sharing_enabled"`
534591
592 - `"claude_ai_skill_plugins_scanning_enabled"`
593
535594 - `"claude_code_desktop_bypass_permissions_enabled"`
536595
537596 - `"claude_code_desktop_enabled"`
from line 687
628687
629688 - `value: boolean`
630689
631 - `type: optional "boolean"`
632
633 default: boolean
634
635690 - `Integer object`
636691
637692 A setting whose enforced value is a whole number; null means no limit
638693 is in force.
639694
640 - `name: "account_session_duration_seconds"`
641
642 - `value: number or null`
643
644695 - `type: optional "integer"`
645696
646697 default: integer
647698
699 - `name: "account_session_duration_seconds"`
700
701 - `value: number or null`
702
648703 - `String object`
649704
650705 A setting whose enforced value is a single string; null means no value
651706 is configured.
652707
708 - `type: optional "string"`
709
710 default: string
711
653712 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
654713
655714 - `"claude_code_default_worker_environment_id"`
from line 717
658717
659718 - `value: string or null`
660719
661 - `type: optional "string"`
662
663 default: string
664
665720 - `StringList object`
666721
667722 A setting whose enforced value is a list of strings.
668723
724 - `type: optional "string_list"`
725
726 default: string_list
727
669728 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
670729
671730 - `"allowed_invite_domains"`
from line 735
676735
677736 - `value: array of string`
678737
679 - `type: optional "string_list"`
680
681 default: string_list
682
683738 - `ProvisioningMode object`
684739
685740 How organization members are provisioned, resolved to the enforced mode.
from line 744
689744 modes require directory sync to be enabled. Otherwise `login_only` is
690745 reported, regardless of any stored configuration.
691746
747 - `type: optional "provisioning_mode"`
748
749 default: provisioning_mode
750
692751 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
693752
694753 How organization members are provisioned under SSO.
from line 766
707766
708767 default: sso_provisioning_mode
709768
710 - `type: optional "provisioning_mode"`
711
712 default: provisioning_mode
713
714769 - `DataRetention object`
715770
716771 The data retention periods in force, keyed by the type of data they
from line 776
721776 administrator-configured retention period is in force for that data type;
722777 Anthropic's service defaults may still apply.
723778
779 - `type: optional "data_retention"`
780
781 default: data_retention
782
724783 - `value: map[object or object]`
725784
726785 - `Fixed object`
from line 786
727786
728787 A fixed retention window measured from each item's last activity.
729788
789 - `type: optional "fixed"`
790
791 default: fixed
792
730793 - `duration: number`
731794
732795 - `timescale: "day" or "month"`
from line 798
735798
736799 - `"month"`
737800
738 - `type: optional "fixed"`
739
740 default: fixed
741
742801 - `Indefinite object`
743802
744803 An indefinite retention period: data is kept with no time limit.
from line 809
750809 - `name: optional "data_retention_periods"`
751810
752811 default: data_retention_periods
753
754 - `type: optional "data_retention"`
755
756 default: data_retention
757
758- `type: optional "effective_organization_settings"`
759
760 default: effective_organization_settings
761812
762813#### Example
763814
api/compliance/organizations/list Changed · +11 / -0 lines
from line 1
1---
2title: List organizations
3url: https://platform.claude.com/docs/en/api/compliance/organizations/list
4---
5
16# List organizations
27
38**GET** `/v1/compliance/organizations`
from line 26
2126 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.
2227
2328## Headers
29
30- `"anthropic-version": optional string`
31
32 The version of the Claude API you want to use.
33
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2435
2536- `"x-api-key": optional string`
2637
api/compliance/organizations/roles Changed · +51 / -12 lines
from line 1
1---
2title: Roles
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles
4---
5
16# Roles
27
38## List Compliance Roles
from line 31
2631
2732### Headers
2833
34- `"anthropic-version": optional string`
35
36 The version of the Claude API you want to use.
37
38 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
39
2940- `"x-api-key": optional string`
3041
3142### Returns
from line 51
4051
4152 - `created_at: string or null`
4253
43 Role creation timestamp (ISO 8601)
54 Role creation timestamp (RFC 3339)
4455
56 format: date-time
57
4558 - `description: string`
4659
4760 Role description
from line 65
5265
5366 - `updated_at: string or null`
5467
55 Role last-updated timestamp (ISO 8601)
68 Role last-updated timestamp (RFC 3339)
5669
70 format: date-time
71
5772- `has_more: boolean`
5873
5974 Whether more records exist beyond the current result set
from line 91
7691 "data": [
7792 {
7893 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
79 "created_at": "2025-03-12T18:22:41.123456",
94 "created_at": "2025-03-12T18:22:41.123456Z",
8095 "description": "Full administrative access to organization settings and members",
8196 "name": "Organization Admin",
82 "updated_at": "2025-03-14T09:05:17.456789"
97 "updated_at": "2025-03-14T09:05:17.456789Z"
8398 }
8499 ],
85100 "has_more": true,
from line 120
105120
106121### Headers
107122
123- `"anthropic-version": optional string`
124
125 The version of the Claude API you want to use.
126
127 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
128
108129- `"x-api-key": optional string`
109130
110131### Returns
from line 136
115136
116137- `created_at: string or null`
117138
118 Role creation timestamp (ISO 8601)
139 Role creation timestamp (RFC 3339)
119140
141 format: date-time
142
120143- `description: string`
121144
122145 Role description
from line 150
127150
128151- `updated_at: string or null`
129152
130 Role last-updated timestamp (ISO 8601)
153 Role last-updated timestamp (RFC 3339)
131154
155 format: date-time
156
132157### Example
133158
134159```bash
from line 166
141166```json
142167{
143168 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
144 "created_at": "2025-03-12T18:22:41.123456",
169 "created_at": "2025-03-12T18:22:41.123456Z",
145170 "description": "Full administrative access to organization settings and members",
146171 "name": "Organization Admin",
147 "updated_at": "2025-03-14T09:05:17.456789"
172 "updated_at": "2025-03-14T09:05:17.456789Z"
148173}
149174```
150175
from line 187
162187
163188 - `created_at: string or null`
164189
165 Role creation timestamp (ISO 8601)
190 Role creation timestamp (RFC 3339)
166191
192 format: date-time
193
167194 - `description: string`
168195
169196 Role description
from line 201
174201
175202 - `updated_at: string or null`
176203
177 Role last-updated timestamp (ISO 8601)
204 Role last-updated timestamp (RFC 3339)
178205
206 format: date-time
207
179208### Role List Response
180209
181210- `RoleListResponse object`
from line 217
188217
189218 - `created_at: string or null`
190219
191 Role creation timestamp (ISO 8601)
220 Role creation timestamp (RFC 3339)
192221
222 format: date-time
223
193224 - `description: string`
194225
195226 Role description
from line 231
200231
201232 - `updated_at: string or null`
202233
203 Role last-updated timestamp (ISO 8601)
234 Role last-updated timestamp (RFC 3339)
204235
236 format: date-time
237
205238## Roles › Permissions
206239
207240### List Compliance Role Permissions
from line 266
233266 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.
234267
235268#### Headers
269
270- `"anthropic-version": optional string`
271
272 The version of the Claude API you want to use.
273
274 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
236275
237276- `"x-api-key": optional string`
238277
api/compliance/organizations/roles/list Changed · +19 / -4 lines
from line 1
1---
2title: List Compliance Roles
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/list
4---
5
16# List Compliance Roles
27
38**GET** `/v1/compliance/organizations/{org_uuid}/roles`
from line 29
2429
2530## Headers
2631
32- `"anthropic-version": optional string`
33
34 The version of the Claude API you want to use.
35
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37
2738- `"x-api-key": optional string`
2839
2940## Returns
from line 49
3849
3950 - `created_at: string or null`
4051
41 Role creation timestamp (ISO 8601)
52 Role creation timestamp (RFC 3339)
4253
54 format: date-time
55
4356 - `description: string`
4457
4558 Role description
from line 63
5063
5164 - `updated_at: string or null`
5265
53 Role last-updated timestamp (ISO 8601)
66 Role last-updated timestamp (RFC 3339)
5467
68 format: date-time
69
5570- `has_more: boolean`
5671
5772 Whether more records exist beyond the current result set
from line 89
7489 "data": [
7590 {
7691 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
77 "created_at": "2025-03-12T18:22:41.123456",
92 "created_at": "2025-03-12T18:22:41.123456Z",
7893 "description": "Full administrative access to organization settings and members",
7994 "name": "Organization Admin",
80 "updated_at": "2025-03-14T09:05:17.456789"
95 "updated_at": "2025-03-14T09:05:17.456789Z"
8196 }
8297 ],
8398 "has_more": true,
api/compliance/organizations/roles/permissions Changed · +11 / -0 lines
from line 1
1---
2title: Permissions
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions
4---
5
16# Permissions
27
38## List Compliance Role Permissions
from line 34
2934 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.
3035
3136### Headers
37
38- `"anthropic-version": optional string`
39
40 The version of the Claude API you want to use.
41
42 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3243
3344- `"x-api-key": optional string`
3445