The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Chats
3url: https://platform.claude.com/docs/en/api/compliance/apps/chats
4---
5
16# Chats
27
38## List chats
from line 116
111116
112117### Headers
113118
119- `"anthropic-version": optional string`
120
121 The version of the Claude API you want to use.
122
123 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
124
114125- `"x-api-key": optional string`
115126
116127### Returns
from line 174
163174
164175 - `user: object or null`
165176
166 User information for compliance responses.
177 The user who created the chat.
167178
179 Null when the API key is restricted to one organization and the creator
180 is no longer a member of it (for example, after they were removed from
181 it).
182
183 A key for the whole parent organization returns the creator's `id`
184 and current `email_address` for every chat; on the list endpoint, pass
185 `organization_ids[]` to keep the results to one organization. For the
186 email address the creator had when the chat was created, query
187 `GET /v1/compliance/activities` with `activity_types[]=claude_chat_created`
188 and a `created_at` window around the chat's `created_at`, find the event
189 whose `claude_chat_id` matches this chat's `id`, and read
190 `actor.email_address`. These events exist only for chats created after
191 compliance logging was enabled for the organization.
192
168193 - `id: string`
169194
170195 User identifier
from line 265
240265
241266### Headers
242267
243- `"x-api-key": optional string`
268- `"anthropic-version": optional string`
244269
245### Returns
270 The version of the Claude API you want to use.
246271
247- `id: string`
272 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
248273
249 The ID of the Claude chat that was deleted
274- `"x-api-key": optional string`
250275
276### Returns
277
251278- `type: optional "claude_chat_deleted"`
252279
253280 Constant string confirming deletion
from line 281
254281
255282 default: claude_chat_deleted
256283
284- `id: string`
285
286 The ID of the Claude chat that was deleted
287
257288### Example
258289
259290```bash
from line 354
323354
324355 - `user: object or null`
325356
326 User information for compliance responses.
357 The user who created the chat.
327358
359 Null when the API key is restricted to one organization and the creator
360 is no longer a member of it (for example, after they were removed from
361 it).
362
363 A key for the whole parent organization returns the creator's `id`
364 and current `email_address` for every chat; on the list endpoint, pass
365 `organization_ids[]` to keep the results to one organization. For the
366 email address the creator had when the chat was created, query
367 `GET /v1/compliance/activities` with `activity_types[]=claude_chat_created`
368 and a `created_at` window around the chat's `created_at`, find the event
369 whose `claude_chat_id` matches this chat's `id`, and read
370 `actor.email_address`. These events exist only for chats created after
371 compliance logging was enabled for the organization.
372
328373 - `id: string`
329374
330375 User identifier
from line 390
345390
346391 Response for deleting a Claude chat.
347392
348 - `id: string`
349
350 The ID of the Claude chat that was deleted
351
352393 - `type: optional "claude_chat_deleted"`
353394
354395 Constant string confirming deletion
from line 396
355396
356397 default: claude_chat_deleted
357398
399 - `id: string`
400
401 The ID of the Claude chat that was deleted
402
358403## Chats › Messages
359404
360405### Get chat messages
from line 506
461506
462507#### Headers
463508
509- `"anthropic-version": optional string`
510
511 The version of the Claude API you want to use.
512
513 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
514
464515- `"x-api-key": optional string`
465516
466517#### Returns
from line 556
505556
506557 Text content block.
507558
559 - `type: "text"`
560
561 default: text
562
508563 - `text: string`
509564
510565 Text content from human or assistant
from line 576
521576
522577 default: false
523578
524 - `type: "text"`
525
526 default: text
527
528579 - `ToolUse object`
529580
530581 Tool invocation requested by the assistant.
531582
583 - `type: "tool_use"`
584
585 default: tool_use
586
532587 - `id: string or null`
533588
534589 Tool-use ID, e.g. 'toolu_01AbC...'
from line 610
555610
556611 default: false
557612
558 - `type: "tool_use"`
559
560 default: tool_use
561
562613 - `ToolResult object`
563614
564615 Result returned by a tool invocation.
565616
617 - `type: "tool_result"`
618
619 default: tool_result
620
566621 - `content: array of object`
567622
568623 Text content returned by the tool. Generated files are surfaced via the message's `generated_files` list; other non-text item types (including images and links) are omitted.
569624
570 - `text: string`
571
572 Text returned by the tool
573
574625 - `type: "text"`
575626
576627 default: text
577628
629 - `text: string`
630
631 Text returned by the tool
632
578633 - `integration_name: string or null`
579634
580635 Name of the integration that provides this tool, when applicable
from line 656
601656
602657 default: false
603658
604 - `type: "tool_result"`
605
606 default: tool_result
607
608659 - `created_at: string`
609660
610661 Message creation timestamp - For human: when they sent the message, For assistant: when it completed the last content block
from line 778
727778
728779- `user: object or null`
729780
730 User information for compliance responses.
781 The user who created the chat.
731782
783 Null when the API key is restricted to one organization and the creator
784 is no longer a member of it (for example, after they were removed from
785 it).
786
787 A key for the whole parent organization returns the creator's `id`
788 and current `email_address` for every chat; on the list endpoint, pass
789 `organization_ids[]` to keep the results to one organization. For the
790 email address the creator had when the chat was created, query
791 `GET /v1/compliance/activities` with `activity_types[]=claude_chat_created`
792 and a `created_at` window around the chat's `created_at`, find the event
793 whose `claude_chat_id` matches this chat's `id`, and read
794 `actor.email_address`. These events exist only for chats created after
795 compliance logging was enabled for the organization.
796
732797 - `id: string`
733798
734799 User identifier
from line 898
833898
834899#### Headers
835900
901- `"anthropic-version": optional string`
902
903 The version of the Claude API you want to use.
904
905 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
906
836907- `"x-api-key": optional string`
837908
838909#### Returns
from line 983
912983
913984#### Headers
914985
915- `"x-api-key": optional string`
986- `"anthropic-version": optional string`
916987
917#### Returns
988 The version of the Claude API you want to use.
918989
919- `id: string`
990 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
920991
921 The ID of the file that was deleted
992- `"x-api-key": optional string`
922993
994#### Returns
995
923996- `type: optional "claude_file_deleted"`
924997
925998 Constant string confirming deletion
from line 999
926999
9271000 default: claude_file_deleted
9281001
1002- `id: string`
1003
1004 The ID of the file that was deleted
1005
9291006#### Example
9301007
9311008```bash
from line 1034
9571034
9581035#### Headers
9591036
1037- `"anthropic-version": optional string`
1038
1039 The version of the Claude API you want to use.
1040
1041 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1042
9601043- `"x-api-key": optional string`
9611044
9621045#### Example
from line 1067
9841067
9851068#### Headers
9861069
1070- `"anthropic-version": optional string`
1071
1072 The version of the Claude API you want to use.
1073
1074 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1075
9871076- `"x-api-key": optional string`
9881077
9891078#### Returns
from line 1141
10521141 The generated-file id (e.g., 'claude_gen_file_abc123') as returned in `chat_messages[].generated_files[].id` from GET /apps/chats/{claude_chat_id}/messages.
10531142
10541143#### Headers
1144
1145- `"anthropic-version": optional string`
1146
1147 The version of the Claude API you want to use.
1148
1149 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
10551150
10561151- `"x-api-key": optional string`
10571152