The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Files
3url: https://platform.claude.com/docs/en/api/beta/files
4---
5
16# Files
27
38## Upload File
from line 19
1419
1520 - `string`
1621
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1823
1924 - `"message-batches-2024-09-24"`
2025
from line 67
6267
6368 - `"user-profiles-2026-08-18"`
6469
70 - `"user-profiles-2026-09-04"`
71
6572 - `"advisor-tool-2026-03-01"`
6673
6774 - `"managed-agents-2026-04-01"`
from line 111
104111
105112 - `"mid-conversation-system-clear-at-2026-08-21"`
106113
114- `"anthropic-workspace-id": optional string`
115
107116### Body parameters (form-data)
108117
109118- `file: string`
110119
111 The file to upload
120 The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for the file's stored `mime_type`, when known.
112121
113122 format: binary
114123
from line 131
122131
123132- `BetaFileMetadata object`
124133
134 - `type: "file"`
135
136 Object type.
137
138 For files, this is always `"file"`.
139
125140 - `id: string`
126141
127142 Unique object identifier.
from line 167
152167
153168 minimum: 0
154169
155 - `type: "file"`
156
157 Object type.
158
159 For files, this is always `"file"`.
160
161170 - `downloadable: optional boolean`
162171
163172 Whether the file can be downloaded.
from line 183
174183
175184 The scope of this file, indicating the context in which it was created (e.g., a session).
176185
177 - `id: string`
178
179 The ID of the scoping resource (e.g., the session ID).
180
181186 - `type: "session"`
182187
183188 The type of scope (e.g., `"session"`).
184189
190 - `id: string`
191
192 The ID of the scoping resource (e.g., the session ID).
193
185194### Example
186195
187196```bash
from line 256
247256
248257 - `string`
249258
250 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
259 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
251260
252261 - `"message-batches-2024-09-24"`
253262
from line 304
295304
296305 - `"user-profiles-2026-08-18"`
297306
307 - `"user-profiles-2026-09-04"`
308
298309 - `"advisor-tool-2026-03-01"`
299310
300311 - `"managed-agents-2026-04-01"`
from line 348
337348
338349 - `"mid-conversation-system-clear-at-2026-08-21"`
339350
351- `"anthropic-workspace-id": optional string`
352
340353### Returns
341354
342355- `data: array of BetaFileMetadata`
from line 356
343356
344357 List of file metadata objects.
345358
359 - `type: "file"`
360
361 Object type.
362
363 For files, this is always `"file"`.
364
346365 - `id: string`
347366
348367 Unique object identifier.
from line 392
373392
374393 minimum: 0
375394
376 - `type: "file"`
377
378 Object type.
379
380 For files, this is always `"file"`.
381
382395 - `downloadable: optional boolean`
383396
384397 Whether the file can be downloaded.
from line 408
395408
396409 The scope of this file, indicating the context in which it was created (e.g., a session).
397410
398 - `id: string`
399
400 The ID of the scoping resource (e.g., the session ID).
401
402411 - `type: "session"`
403412
404413 The type of scope (e.g., `"session"`).
405414
415 - `id: string`
416
417 The ID of the scoping resource (e.g., the session ID).
418
406419- `next_page: optional string or null`
407420
408421 Opaque cursor for the next page. Supply as `?page=` to fetch the next page; null when there are no more results.
from line 472
459472
460473 - `string`
461474
462 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
475 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
463476
464477 - `"message-batches-2024-09-24"`
465478
from line 520
507520
508521 - `"user-profiles-2026-08-18"`
509522
523 - `"user-profiles-2026-09-04"`
524
510525 - `"advisor-tool-2026-03-01"`
511526
512527 - `"managed-agents-2026-04-01"`
from line 564
549564
550565 - `"mid-conversation-system-clear-at-2026-08-21"`
551566
567- `"anthropic-workspace-id": optional string`
568
552569### Example
553570
554571```bash
from line 594
577594
578595 - `string`
579596
580 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
597 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
581598
582599 - `"message-batches-2024-09-24"`
583600
from line 642
625642
626643 - `"user-profiles-2026-08-18"`
627644
645 - `"user-profiles-2026-09-04"`
646
628647 - `"advisor-tool-2026-03-01"`
629648
630649 - `"managed-agents-2026-04-01"`
from line 686
667686
668687 - `"mid-conversation-system-clear-at-2026-08-21"`
669688
689- `"anthropic-workspace-id": optional string`
690
670691### Returns
671692
672693- `BetaFileMetadata object`
673694
695 - `type: "file"`
696
697 Object type.
698
699 For files, this is always `"file"`.
700
674701 - `id: string`
675702
676703 Unique object identifier.
from line 728
701728
702729 minimum: 0
703730
704 - `type: "file"`
705
706 Object type.
707
708 For files, this is always `"file"`.
709
710731 - `downloadable: optional boolean`
711732
712733 Whether the file can be downloaded.
from line 744
723744
724745 The scope of this file, indicating the context in which it was created (e.g., a session).
725746
726 - `id: string`
727
728 The ID of the scoping resource (e.g., the session ID).
729
730747 - `type: "session"`
731748
732749 The type of scope (e.g., `"session"`).
733750
751 - `id: string`
752
753 The ID of the scoping resource (e.g., the session ID).
754
734755### Example
735756
736757```bash
from line 799
778799
779800 - `string`
780801
781 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
802 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
782803
783804 - `"message-batches-2024-09-24"`
784805
from line 847
826847
827848 - `"user-profiles-2026-08-18"`
828849
850 - `"user-profiles-2026-09-04"`
851
829852 - `"advisor-tool-2026-03-01"`
830853
831854 - `"managed-agents-2026-04-01"`
from line 891
868891
869892 - `"mid-conversation-system-clear-at-2026-08-21"`
870893
894- `"anthropic-workspace-id": optional string`
895
871896### Returns
872897
873898- `BetaDeletedFile object`
874899
875 - `id: string`
876
877 ID of the deleted file.
878
879900 - `type: optional "file_deleted"`
880901
881902 Deleted object type.
from line 905
884905
885906 default: file_deleted
886907
908 - `id: string`
909
910 ID of the deleted file.
911
887912### Example
888913
889914```bash
from line 933
908933
909934- `BetaDeletedFile object`
910935
911 - `id: string`
912
913 ID of the deleted file.
914
915936 - `type: optional "file_deleted"`
916937
917938 Deleted object type.
from line 941
920941
921942 default: file_deleted
922943
944 - `id: string`
945
946 ID of the deleted file.
947
923948### Beta File Metadata
924949
925950- `BetaFileMetadata object`
926951
952 - `type: "file"`
953
954 Object type.
955
956 For files, this is always `"file"`.
957
927958 - `id: string`
928959
929960 Unique object identifier.
from line 985
954985
955986 minimum: 0
956987
957 - `type: "file"`
958
959 Object type.
960
961 For files, this is always `"file"`.
962
963988 - `downloadable: optional boolean`
964989
965990 Whether the file can be downloaded.
from line 1001
9761001
9771002 The scope of this file, indicating the context in which it was created (e.g., a session).
9781003
979 - `id: string`
980
981 The ID of the scoping resource (e.g., the session ID).
982
9831004 - `type: "session"`
9841005
9851006 The type of scope (e.g., `"session"`).
9861007
1008 - `id: string`
1009
1010 The ID of the scoping resource (e.g., the session ID).
1011
9871012### Beta File Scope
9881013
9891014- `BetaFileScope object`
9901015
991 - `id: string`
992
993 The ID of the scoping resource (e.g., the session ID).
994
9951016 - `type: "session"`
9961017
9971018 The type of scope (e.g., `"session"`).
1019
1020 - `id: string`
1021
1022 The ID of the scoping resource (e.g., the session ID).
9981023