The whole hunk
from line 1, old and new numbered
/
lines
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Retrieve Message Batch results
3url: https://platform.claude.com/docs/en/api/beta/messages/batches/results
4---
5
16# Retrieve Message Batch results
27
38**GET** `/v1/messages/batches/{message_batch_id}/results`
from line 27
2227
2328 - `string`
2429
25 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2631
2732 - `"message-batches-2024-09-24"`
2833
from line 75
7075
7176 - `"user-profiles-2026-08-18"`
7277
78 - `"user-profiles-2026-09-04"`
79
7380 - `"advisor-tool-2026-03-01"`
7481
7582 - `"managed-agents-2026-04-01"`
from line 119
112119
113120 - `"mid-conversation-system-clear-at-2026-08-21"`
114121
122- `"anthropic-workspace-id": optional string`
123
115124## Returns
116125
117126- `BetaMessageBatchIndividualResponse object`
from line 141
132141
133142 - `BetaMessageBatchSucceededResult object`
134143
144 - `type: "succeeded"`
145
146 default: succeeded
147
135148 - `message: BetaMessage`
136149
150 - `type: "message"`
151
152 Object type.
153
154 For Messages, this is always `"message"`.
155
156 default: message
157
137158 - `id: string`
138159
139160 Unique object identifier.
from line 179
158179
159180 Skills loaded in the container
160181
182 - `type: "anthropic" or "custom"`
183
184 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
185
186 - `"anthropic"`
187
188 - `"custom"`
189
161190 - `skill_id: string`
162191
163192 Skill ID
164193
165194 maxLength: 64, minLength: 1
166
167 - `type: "anthropic" or "custom"`
168
169 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
170
171 - `"anthropic"`
172
173 - `"custom"`
174195
175196 - `version: string`
176197
from line 230
209230
210231 - `BetaTextBlock object`
211232
233 - `type: "text"`
234
235 default: text
236
212237 - `citations: array of BetaTextCitation or null`
213238
214239 Citations supporting the text block.
from line 242
217242
218243 - `BetaCitationCharLocation object`
219244
245 - `type: "char_location"`
246
247 default: char_location
248
220249 - `cited_text: string`
221250
222251 - `document_index: number`
from line 262
233262
234263 minimum: 0
235264
236 - `type: "char_location"`
237
238 default: char_location
239
240265 - `BetaCitationPageLocation object`
241266
267 - `type: "page_location"`
268
269 default: page_location
270
242271 - `cited_text: string`
243272
244273 - `document_index: number`
from line 284
255284
256285 minimum: 1
257286
258 - `type: "page_location"`
259
260 default: page_location
261
262287 - `BetaCitationContentBlockLocation object`
263288
289 - `type: "content_block_location"`
290
291 default: content_block_location
292
264293 - `cited_text: string`
265294
266295 The full text of the cited block range, concatenated.
from line 316
287316
288317 minimum: 0
289318
290 - `type: "content_block_location"`
291
292 default: content_block_location
293
294319 - `BetaCitationsWebSearchResultLocation object`
295320
321 - `type: "web_search_result_location"`
322
323 default: web_search_result_location
324
296325 - `cited_text: string`
297326
298327 - `encrypted_index: string`
from line 330
301330
302331 maxLength: 512
303332
304 - `type: "web_search_result_location"`
305
306 default: web_search_result_location
307
308333 - `url: string`
309334
310335 - `BetaCitationSearchResultLocation object`
311336
337 - `type: "search_result_location"`
338
339 default: search_result_location
340
312341 - `cited_text: string`
313342
314343 The full text of the cited block range, concatenated.
from line 368
339368
340369 - `title: string or null`
341370
342 - `type: "search_result_location"`
343
344 default: search_result_location
345
346371 - `text: string`
347372
348 maxLength: 5000000, minLength: 0
349
350 - `type: "text"`
351
352 default: text
373 minLength: 0
353374
354375 - `BetaThinkingBlock object`
355376
377 - `type: "thinking"`
378
379 default: thinking
380
356381 - `signature: string`
357382
358383 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 390
365390
366391 The text of Claude's thinking process for this block.
367392
368 - `type: "thinking"`
369
370 default: thinking
371
372393 - `BetaRedactedThinkingBlock object`
373394
395 - `type: "redacted_thinking"`
396
397 default: redacted_thinking
398
374399 - `data: string`
375400
376401 The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content.
from line 404
379404
380405 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
381406
382 - `type: "redacted_thinking"`
383
384 default: redacted_thinking
385
386407 - `BetaToolUseBlock object`
387408
409 - `type: "tool_use"`
410
411 default: tool_use
412
388413 - `id: string`
389414
390415 pattern: ^[a-zA-Z0-9_-]+$
from line 420
395420
396421 minLength: 1
397422
398 - `type: "tool_use"`
399
400 default: tool_use
401
402423 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`
403424
404425 Tool invocation directly from the model.
from line 434
413434
414435 Tool invocation generated by a server-side tool.
415436
437 - `type: "code_execution_20250825"`
438
416439 - `tool_id: string`
417440
418441 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
419442
420 - `type: "code_execution_20250825"`
421
422443 - `BetaServerToolCaller20260120 object`
423444
445 - `type: "code_execution_20260120"`
446
424447 - `tool_id: string`
425448
426449 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
427450
428 - `type: "code_execution_20260120"`
429
430451 - `toolset_name: optional string or null`
431452
432453 For a toolset member tool_use, the toolset family.
from line 456
435456
436457 - `BetaServerToolUseBlock object`
437458
459 - `type: "server_tool_use"`
460
461 default: server_tool_use
462
438463 - `id: string`
439464
440465 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 484
459484
460485 - `"tool_search_tool_bm25"`
461486
462 - `type: "server_tool_use"`
463
464 default: server_tool_use
465
466487 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`
467488
468489 Tool invocation directly from the model.
from line 500
479500
480501 - `BetaWebSearchToolResultBlock object`
481502
503 - `type: "web_search_tool_result"`
504
505 default: web_search_tool_result
506
482507 - `content: BetaWebSearchToolResultBlockContent`
483508
484509 - `BetaWebSearchToolResultError object`
485510
511 - `type: "web_search_tool_result_error"`
512
513 default: web_search_tool_result_error
514
486515 - `error_code: BetaWebSearchToolResultErrorCode`
487516
488517 - `"invalid_tool_input"`
from line 526
497526
498527 - `"request_too_large"`
499528
500 - `type: "web_search_tool_result_error"`
501
502 default: web_search_tool_result_error
503
504529 - `array of BetaWebSearchResultBlock`
505530
531 - `type: "web_search_result"`
532
533 default: web_search_result
534
506535 - `encrypted_content: string`
507536
508537 - `page_age: string or null`
509538
510539 - `title: string`
511540
512 - `type: "web_search_result"`
513
514 default: web_search_result
515
516541 - `url: string`
517542
518543 - `tool_use_id: string`
519544
520545 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
521546
522 - `type: "web_search_tool_result"`
523
524 default: web_search_tool_result
525
526547 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`
527548
528549 Tool invocation directly from the model.
from line 560
539560
540561 - `BetaWebFetchToolResultBlock object`
541562
563 - `type: "web_fetch_tool_result"`
564
565 default: web_fetch_tool_result
566
542567 - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock`
543568
544569 - `BetaWebFetchToolResultErrorBlock object`
545570
571 - `type: "web_fetch_tool_result_error"`
572
573 default: web_fetch_tool_result_error
574
546575 - `error_code: BetaWebFetchToolResultErrorCode`
547576
548577 - `"invalid_tool_input"`
from line 592
563592
564593 - `"unavailable"`
565594
566 - `type: "web_fetch_tool_result_error"`
567
568 default: web_fetch_tool_result_error
595 - `"content_too_large"`
569596
570597 - `BetaWebFetchBlock object`
571598
599 - `type: "web_fetch_result"`
600
601 default: web_fetch_result
602
572603 - `content: BetaDocumentBlock`
573604
605 - `type: "document"`
606
607 default: document
608
574609 - `citations: BetaCitationConfig or null`
575610
576611 Citation configuration for the document
from line 618
583618
584619 - `BetaBase64PDFSource object`
585620
621 - `type: "base64"`
622
586623 - `data: string`
587624
588625 format: byte
589626
590627 - `media_type: "application/pdf"`
591628
592 - `type: "base64"`
593
594629 - `BetaPlainTextSource object`
595630
631 - `type: "text"`
632
596633 - `data: string`
597634
598635 - `media_type: "text/plain"`
599636
600 - `type: "text"`
601
602637 - `title: string or null`
603638
604639 The title of the document
605640
606 - `type: "document"`
607
608 default: document
609
610641 - `retrieved_at: string or null`
611642
612643 ISO 8601 timestamp when the content was retrieved
613644
614 - `type: "web_fetch_result"`
615
616 default: web_fetch_result
617
618645 - `url: string`
619646
620647 Fetched content URL
from line 650
623650
624651 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
625652
626 - `type: "web_fetch_tool_result"`
627
628 default: web_fetch_tool_result
629
630653 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120`
631654
632655 Tool invocation directly from the model.
from line 666
643666
644667 - `BetaAdvisorToolResultBlock object`
645668
669 - `type: "advisor_tool_result"`
670
671 default: advisor_tool_result
672
646673 - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock`
647674
648675 - `BetaAdvisorToolResultError object`
649676
677 - `type: "advisor_tool_result_error"`
678
679 default: advisor_tool_result_error
680
650681 - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more`
651682
652683 - `"max_uses_exceeded"`
from line 694
663694
664695 - `"model_not_found"`
665696
666 - `type: "advisor_tool_result_error"`
667
668 default: advisor_tool_result_error
669
670697 - `BetaAdvisorResultBlock object`
671698
699 - `type: "advisor_result"`
700
701 default: advisor_result
702
672703 - `stop_reason: string or null`
673704
674705 The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap.
675706
676707 - `text: string`
677708
678 - `type: "advisor_result"`
679
680 default: advisor_result
681
682709 - `BetaAdvisorRedactedResultBlock object`
683710
711 - `type: "advisor_redacted_result"`
712
713 default: advisor_redacted_result
714
684715 - `encrypted_content: string`
685716
686717 Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.
from line 720
689720
690721 The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`).
691722
692 - `type: "advisor_redacted_result"`
693
694 default: advisor_redacted_result
695
696723 - `tool_use_id: string`
697724
698725 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
699726
700 - `type: "advisor_tool_result"`
701
702 default: advisor_tool_result
703
704727 - `BetaCodeExecutionToolResultBlock object`
705728
729 - `type: "code_execution_tool_result"`
730
731 default: code_execution_tool_result
732
706733 - `content: BetaCodeExecutionToolResultBlockContent`
707734
708735 Code execution result with encrypted stdout for PFC + web_search results.
709736
710737 - `BetaCodeExecutionToolResultError object`
711738
739 - `type: "code_execution_tool_result_error"`
740
741 default: code_execution_tool_result_error
742
712743 - `error_code: BetaCodeExecutionToolResultErrorCode`
713744
714745 - `"invalid_tool_input"`
from line 750
719750
720751 - `"execution_time_exceeded"`
721752
722 - `type: "code_execution_tool_result_error"`
723
724 default: code_execution_tool_result_error
725
726753 - `BetaCodeExecutionResultBlock object`
727754
755 - `type: "code_execution_result"`
756
757 default: code_execution_result
758
728759 - `content: array of BetaCodeExecutionOutputBlock`
729760
761 - `type: "code_execution_output"`
762
763 default: code_execution_output
764
730765 - `file_id: string`
731766
767 - `return_code: number`
768
769 - `stderr: string`
770
771 - `stdout: string`
772
773 - `BetaEncryptedCodeExecutionResultBlock object`
774
775 Code execution result with encrypted stdout for PFC + web_search results.
776
777 - `type: "encrypted_code_execution_result"`
778
779 default: encrypted_code_execution_result
780
781 - `content: array of BetaCodeExecutionOutputBlock`
782
732783 - `type: "code_execution_output"`
733784
734785 default: code_execution_output
735786
787 - `file_id: string`
788
789 - `encrypted_stdout: string`
790
736791 - `return_code: number`
737792
738793 - `stderr: string`
739794
795 - `tool_use_id: string`
796
797 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
798
799 - `BetaBashCodeExecutionToolResultBlock object`
800
801 - `type: "bash_code_execution_tool_result"`
802
803 default: bash_code_execution_tool_result
804
805 - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock`
806
807 - `BetaBashCodeExecutionToolResultError object`
808
809 - `type: "bash_code_execution_tool_result_error"`
810
811 default: bash_code_execution_tool_result_error
812
813 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`
814
815 - `"invalid_tool_input"`
816
817 - `"unavailable"`
818
819 - `"too_many_requests"`
820
821 - `"execution_time_exceeded"`
822
823 - `"output_file_too_large"`
824
825 - `BetaBashCodeExecutionResultBlock object`
826
827 - `type: "bash_code_execution_result"`
828
829 default: bash_code_execution_result
830
831 - `content: array of BetaBashCodeExecutionOutputBlock`
832
833 - `type: "bash_code_execution_output"`
834
835 default: bash_code_execution_output
836
837 - `file_id: string`
838
839 - `return_code: number`
840
841 - `stderr: string`
842
740843 - `stdout: string`
741844
742 - `type: "code_execution_result"`
743
744 default: code_execution_result
745
746 - `BetaEncryptedCodeExecutionResultBlock object`
747
748 Code execution result with encrypted stdout for PFC + web_search results.
749
750 - `content: array of BetaCodeExecutionOutputBlock`
751
752 - `file_id: string`
753
754 - `type: "code_execution_output"`
755
756 default: code_execution_output
757
758 - `encrypted_stdout: string`
759
760 - `return_code: number`
761
762 - `stderr: string`
763
764 - `type: "encrypted_code_execution_result"`
765
766 default: encrypted_code_execution_result
767
768845 - `tool_use_id: string`
769846
770847 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
771848
772 - `type: "code_execution_tool_result"`
773
774 default: code_execution_tool_result
775
776 - `BetaBashCodeExecutionToolResultBlock object`
777
778 - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock`
779
780 - `BetaBashCodeExecutionToolResultError object`
849 - `BetaTextEditorCodeExecutionToolResultBlock object`
850
851 - `type: "text_editor_code_execution_tool_result"`
852
853 default: text_editor_code_execution_tool_result
854
855 - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock`
856
857 - `BetaTextEditorCodeExecutionToolResultError object`
858
859 - `type: "text_editor_code_execution_tool_result_error"`
860
861 default: text_editor_code_execution_tool_result_error
781862
782863 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`
783864
from line 870
789870
790871 - `"execution_time_exceeded"`
791872
792 - `"output_file_too_large"`
793
794 - `type: "bash_code_execution_tool_result_error"`
795
796 default: bash_code_execution_tool_result_error
797
798 - `BetaBashCodeExecutionResultBlock object`
799
800 - `content: array of BetaBashCodeExecutionOutputBlock`
801
802 - `file_id: string`
803
804 - `type: "bash_code_execution_output"`
805
806 default: bash_code_execution_output
807
808 - `return_code: number`
809
810 - `stderr: string`
811
812 - `stdout: string`
813
814 - `type: "bash_code_execution_result"`
815
816 default: bash_code_execution_result
873 - `"file_not_found"`
874
875 - `error_message: string or null`
876
877 - `BetaTextEditorCodeExecutionViewResultBlock object`
878
879 - `type: "text_editor_code_execution_view_result"`
880
881 default: text_editor_code_execution_view_result
882
883 - `content: string`
884
885 - `file_type: "text" or "image" or "pdf"`
886
887 - `"text"`
888
889 - `"image"`
890
891 - `"pdf"`
892
893 - `num_lines: number or null`
894
895 - `start_line: number or null`
896
897 - `total_lines: number or null`
898
899 - `BetaTextEditorCodeExecutionCreateResultBlock object`
900
901 - `type: "text_editor_code_execution_create_result"`
902
903 default: text_editor_code_execution_create_result
904
905 - `is_file_update: boolean`
906
907 - `BetaTextEditorCodeExecutionStrReplaceResultBlock object`
908
909 - `type: "text_editor_code_execution_str_replace_result"`
910
911 default: text_editor_code_execution_str_replace_result
912
913 - `lines: array of string or null`
914
915 - `new_lines: number or null`
916
917 - `new_start: number or null`
918
919 - `old_lines: number or null`
920
921 - `old_start: number or null`
817922
818923 - `tool_use_id: string`
819924
820925 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
821926
822 - `type: "bash_code_execution_tool_result"`
823
824 default: bash_code_execution_tool_result
825
826 - `BetaTextEditorCodeExecutionToolResultBlock object`
827
828 - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock`
829
830 - `BetaTextEditorCodeExecutionToolResultError object`
831
832 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`
927 - `BetaToolSearchToolResultBlock object`
928
929 - `type: "tool_search_tool_result"`
930
931 default: tool_search_tool_result
932
933 - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock`
934
935 - `BetaToolSearchToolResultError object`
936
937 - `type: "tool_search_tool_result_error"`
938
939 default: tool_search_tool_result_error
940
941 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`
833942
834943 - `"invalid_tool_input"`
835944
from line 948
839948
840949 - `"execution_time_exceeded"`
841950
842 - `"file_not_found"`
843
844951 - `error_message: string or null`
845952
846 - `type: "text_editor_code_execution_tool_result_error"`
847
848 default: text_editor_code_execution_tool_result_error
849
850 - `BetaTextEditorCodeExecutionViewResultBlock object`
851
852 - `content: string`
853
854 - `file_type: "text" or "image" or "pdf"`
855
856 - `"text"`
857
858 - `"image"`
859
860 - `"pdf"`
861
862 - `num_lines: number or null`
863
864 - `start_line: number or null`
865
866 - `total_lines: number or null`
867
868 - `type: "text_editor_code_execution_view_result"`
869
870 default: text_editor_code_execution_view_result
871
872 - `BetaTextEditorCodeExecutionCreateResultBlock object`
873
874 - `is_file_update: boolean`
875
876 - `type: "text_editor_code_execution_create_result"`
877
878 default: text_editor_code_execution_create_result
879
880 - `BetaTextEditorCodeExecutionStrReplaceResultBlock object`
881
882 - `lines: array of string or null`
883
884 - `new_lines: number or null`
885
886 - `new_start: number or null`
887
888 - `old_lines: number or null`
889
890 - `old_start: number or null`
891
892 - `type: "text_editor_code_execution_str_replace_result"`
893
894 default: text_editor_code_execution_str_replace_result
953 - `BetaToolSearchToolSearchResultBlock object`
954
955 - `type: "tool_search_tool_search_result"`
956
957 default: tool_search_tool_search_result
958
959 - `tool_references: array of BetaToolReferenceBlock`
960
961 - `type: "tool_reference"`
962
963 default: tool_reference
964
965 - `tool_name: string`
966
967 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
895968
896969 - `tool_use_id: string`
897970
898971 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
899972
900 - `type: "text_editor_code_execution_tool_result"`
901
902 default: text_editor_code_execution_tool_result
903
904 - `BetaToolSearchToolResultBlock object`
905
906 - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock`
907
908 - `BetaToolSearchToolResultError object`
909
910 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"`
911
912 - `"invalid_tool_input"`
913
914 - `"unavailable"`
915
916 - `"too_many_requests"`
917
918 - `"execution_time_exceeded"`
919
920 - `error_message: string or null`
921
922 - `type: "tool_search_tool_result_error"`
923
924 default: tool_search_tool_result_error
925
926 - `BetaToolSearchToolSearchResultBlock object`
927
928 - `tool_references: array of BetaToolReferenceBlock`
929
930 - `tool_name: string`
931
932 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
933
934 - `type: "tool_reference"`
935
936 default: tool_reference
937
938 - `type: "tool_search_tool_search_result"`
939
940 default: tool_search_tool_search_result
973 - `BetaMCPToolUseBlock object`
974
975 - `type: "mcp_tool_use"`
976
977 default: mcp_tool_use
978
979 - `id: string`
980
981 pattern: ^[a-zA-Z0-9_-]+$
982
983 - `input: map[unknown]`
984
985 - `name: string`
986
987 The name of the MCP tool
988
989 - `server_name: string`
990
991 The name of the MCP server
992
993 - `BetaMCPToolResultBlock object`
994
995 - `type: "mcp_tool_result"`
996
997 default: mcp_tool_result
998
999 - `content: string or array of BetaTextBlock`
1000
1001 - `string`
1002
1003 - `BetaMCPToolResultBlockContent = array of BetaTextBlock`
1004
1005 - `type: "text"`
1006
1007 default: text
1008
1009 - `citations: array of BetaTextCitation or null`
1010
1011 Citations supporting the text block.
1012
1013 The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`.
1014
1015 - `text: string`
1016
1017 minLength: 0
1018
1019 - `is_error: boolean`
1020
1021 default: false
9411022
9421023 - `tool_use_id: string`
9431024
944 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
945
946 - `type: "tool_search_tool_result"`
947
948 default: tool_search_tool_result
949
950 - `BetaMCPToolUseBlock object`
951
952 - `id: string`
953
9541025 pattern: ^[a-zA-Z0-9_-]+$
9551026
956 - `input: map[unknown]`
957
958 - `name: string`
959
960 The name of the MCP tool
961
962 - `server_name: string`
963
964 The name of the MCP server
965
966 - `type: "mcp_tool_use"`
967
968 default: mcp_tool_use
969
970 - `BetaMCPToolResultBlock object`
971
972 - `content: string or array of BetaTextBlock`
973
974 - `string`
975
976 - `BetaMCPToolResultBlockContent = array of BetaTextBlock`
977
978 - `citations: array of BetaTextCitation or null`
979
980 Citations supporting the text block.
981
982 The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`.
983
984 - `text: string`
985
986 maxLength: 5000000, minLength: 0
987
988 - `type: "text"`
989
990 default: text
991
992 - `is_error: boolean`
993
994 default: false
995
996 - `tool_use_id: string`
997
998 pattern: ^[a-zA-Z0-9_-]+$
999
1000 - `type: "mcp_tool_result"`
1001
1002 default: mcp_tool_result
1003
10041027 - `BetaContainerUploadBlock object`
10051028
10061029 Response model for a file uploaded to the container.
10071030
1031 - `type: "container_upload"`
1032
1033 default: container_upload
1034
10081035 - `file_id: string`
1009
1010 - `type: "container_upload"`
1011
1012 default: container_upload
10131036
10141037 - `BetaCompactionBlock object`
10151038
from line 1042
10191042 summary (e.g., malformed output from the model). Clients may round-trip
10201043 compaction blocks with null content; the server treats them as no-ops.
10211044
1045 - `type: "compaction"`
1046
1047 default: compaction
1048
10221049 - `content: string or null`
10231050
10241051 Summary of compacted content, or null if compaction failed
from line 1053
10261053 - `encrypted_content: string or null`
10271054
10281055 Opaque metadata from prior compaction, to be round-tripped verbatim
1029
1030 - `type: "compaction"`
1031
1032 default: compaction
10331056
10341057 - `BetaFallbackBlock object`
10351058
from line 1068
10451068 arrives via the standard `content_block_start` / `content_block_stop`
10461069 pair and carries no deltas.
10471070
1071 - `type: "fallback"`
1072
1073 default: fallback
1074
10481075 - `from: BetaFallbackInfo`
10491076
10501077 The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id.
from line 1166
11391166
11401167 What caused the `from` model to hand over at this hop.
11411168
1169 - `type: "refusal"`
1170
1171 default: refusal
1172
11421173 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
11431174
11441175 The policy category that triggered a refusal.
from line 1194
11631194
11641195 The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.
11651196
1166 - `type: "refusal"`
1167
1168 default: refusal
1169
1170 - `type: "fallback"`
1171
1172 default: fallback
1173
11741197 - `context_management: BetaContextManagementResponse or null`
11751198
11761199 Context management response.
from line 1206
11831206
11841207 - `BetaClearToolUses20250919EditResponse object`
11851208
1209 - `type: "clear_tool_uses_20250919"`
1210
1211 The type of context management edit applied.
1212
1213 default: clear_tool_uses_20250919
1214
11861215 - `cleared_input_tokens: number`
11871216
11881217 Number of input tokens cleared by this edit.
from line 1224
11951224
11961225 minimum: 0
11971226
1198 - `type: "clear_tool_uses_20250919"`
1227 - `BetaClearThinking20251015EditResponse object`
1228
1229 - `type: "clear_thinking_20251015"`
11991230
12001231 The type of context management edit applied.
12011232
1202 default: clear_tool_uses_20250919
1203
1204 - `BetaClearThinking20251015EditResponse object`
1233 default: clear_thinking_20251015
12051234
12061235 - `cleared_input_tokens: number`
12071236
from line 1243
12141243 Number of thinking turns that were cleared.
12151244
12161245 minimum: 0
1217
1218 - `type: "clear_thinking_20251015"`
1219
1220 The type of context management edit applied.
1221
1222 default: clear_thinking_20251015
12231246
12241247 - `diagnostics: BetaDiagnostics or null`
12251248
from line 1255
12321255
12331256 - `BetaCacheMissModelChanged object`
12341257
1258 - `type: "model_changed"`
1259
1260 default: model_changed
1261
12351262 - `cache_missed_input_tokens: number`
12361263
12371264 Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
12381265
1239 - `type: "model_changed"`
1240
1241 default: model_changed
1242
12431266 - `BetaCacheMissSystemChanged object`
12441267
1268 - `type: "system_changed"`
1269
1270 default: system_changed
1271
12451272 - `cache_missed_input_tokens: number`
12461273
12471274 Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
12481275
1249 - `type: "system_changed"`
1250
1251 default: system_changed
1252
12531276 - `BetaCacheMissToolsChanged object`
12541277
1278 - `type: "tools_changed"`
1279
1280 default: tools_changed
1281
12551282 - `cache_missed_input_tokens: number`
12561283
12571284 Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
12581285
1259 - `type: "tools_changed"`
1260
1261 default: tools_changed
1262
12631286 - `BetaCacheMissMessagesChanged object`
12641287
1288 - `type: "messages_changed"`
1289
1290 default: messages_changed
1291
12651292 - `cache_missed_input_tokens: number`
12661293
12671294 Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
12681295
1269 - `type: "messages_changed"`
1270
1271 default: messages_changed
1272
12731296 - `BetaCacheMissPreviousMessageNotFound object`
12741297
12751298 - `type: "previous_message_not_found"`
from line 1322
12991322 - `stop_details: BetaRefusalStopDetails or null`
13001323
13011324 Structured information about a refusal.
1325
1326 - `type: "refusal"`
1327
1328 default: refusal
13021329
13031330 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
13041331
from line 1406
13791406
13801407 The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise.
13811408
1382 - `type: "refusal"`
1383
1384 default: refusal
1385
13861409 - `stop_reason: BetaStopReason or null`
13871410
13881411 The reason that we stopped.
from line 1444
14211444
14221445 This value will be a non-null string if one of your custom stop sequences was generated.
14231446
1424 - `type: "message"`
1425
1426 Object type.
1427
1428 For Messages, this is always `"message"`.
1429
1430 default: message
1431
14321447 - `usage: BetaUsage`
14331448
14341449 Billing and rate-limit usage.
from line 1510
14951510
14961511 No reprice was applied; `reason` says why.
14971512
1513 - `type: "not_applied"`
1514
1515 default: not_applied
1516
14981517 - `reason: "body_mismatch" or "continuation_excluded" or "continuation_only" or 9 more`
14991518
15001519 Why the reprice was not applied.
from line 1544
15251544 - `"wrong_platform"`
15261545
15271546 - `"wrong_workspace"`
1528
1529 - `type: "not_applied"`
1530
1531 default: not_applied
15321547
15331548 - `remove_to_redeem: optional array of string or null`
15341549
from line 1582
15671582
15681583 Token usage for a sampling iteration.
15691584
1585 - `type: "message"`
1586
1587 Usage for a sampling iteration
1588
1589 default: message
1590
15701591 - `cache_creation: BetaCacheCreation or null`
15711592
15721593 Breakdown of cached tokens by TTL
from line 1622
16011622
16021623 minimum: 0
16031624
1604 - `type: "message"`
1605
1606 Usage for a sampling iteration
1607
1608 default: message
1609
16101625 - `BetaCompactionIterationUsage object`
16111626
16121627 Token usage for a compaction iteration.
16131628
1629 - `type: "compaction"`
1630
1631 Usage for a compaction iteration
1632
1633 default: compaction
1634
16141635 - `cache_creation: BetaCacheCreation or null`
16151636
16161637 Breakdown of cached tokens by TTL
from line 1660
16391660
16401661 minimum: 0
16411662
1642 - `type: "compaction"`
1643
1644 Usage for a compaction iteration
1645
1646 default: compaction
1647
16481663 - `BetaAdvisorMessageIterationUsage object`
16491664
16501665 Token usage for an advisor sub-inference iteration.
16511666
1667 - `type: "advisor_message"`
1668
1669 Usage for an advisor sub-inference iteration
1670
1671 default: advisor_message
1672
16521673 - `cache_creation: BetaCacheCreation or null`
16531674
16541675 Breakdown of cached tokens by TTL
from line 1703
16821703 The number of output tokens which were used.
16831704
16841705 minimum: 0
1685
1686 - `type: "advisor_message"`
1687
1688 Usage for an advisor sub-inference iteration
1689
1690 default: advisor_message
16911706
16921707 - `BetaFallbackMessageIterationUsage object`
16931708
from line 1713
16981713 a fallback model served the response is signalled by the presence of this
16991714 entry in `usage.iterations`.
17001715
1716 - `type: "fallback_message"`
1717
1718 Usage for the fallback-model attempt that served the response
1719
1720 default: fallback_message
1721
17011722 - `cache_creation: BetaCacheCreation or null`
17021723
17031724 Breakdown of cached tokens by TTL
from line 1752
17311752 The number of output tokens which were used.
17321753
17331754 minimum: 0
1734
1735 - `type: "fallback_message"`
1736
1737 Usage for the fallback-model attempt that served the response
1738
1739 default: fallback_message
17401755
17411756 - `output_tokens: number`
17421757
from line 1832
18171832 the final `message_delta` event carries it only when a server-side model
18181833 fallback happened mid-stream, in which case it holds the serving model's
18191834 entries and replaces the one in `message_start`.
1835
1836 - `type: "thinking_dropped"`
1837
1838 Always `thinking_dropped` for this entry type.
1839
1840 default: thinking_dropped
18201841
18211842 - `path: string`
18221843
from line 1869
18481869
18491870 - `"end_user_binding_mismatch"`
18501871
1851 - `type: "thinking_dropped"`
1852
1853 Always `thinking_dropped` for this entry type.
1854
1855 default: thinking_dropped
1856
1857 - `type: "succeeded"`
1858
1859 default: succeeded
1860
18611872 - `BetaMessageBatchErroredResult object`
18621873
1874 - `type: "errored"`
1875
1876 default: errored
1877
18631878 - `error: BetaErrorResponse`
18641879
1880 - `type: "error"`
1881
1882 default: error
1883
18651884 - `error: BetaError`
18661885
18671886 - `BetaInvalidRequestError object`
18681887
1888 - `type: "invalid_request_error"`
1889
1890 default: invalid_request_error
1891
18691892 - `message: string`
18701893
18711894 default: Invalid request
18721895
1873 - `type: "invalid_request_error"`
1874
1875 default: invalid_request_error
1876
18771896 - `BetaAuthenticationError object`
18781897
1898 - `type: "authentication_error"`
1899
1900 default: authentication_error
1901
18791902 - `message: string`
18801903
18811904 default: Authentication error
18821905
1883 - `type: "authentication_error"`
1884
1885 default: authentication_error
1886
18871906 - `BetaBillingError object`
18881907
1908 - `type: "billing_error"`
1909
1910 default: billing_error
1911
18891912 - `message: string`
18901913
18911914 default: Billing error
18921915
1893 - `type: "billing_error"`
1894
1895 default: billing_error
1896
18971916 - `BetaPermissionError object`
18981917
1918 - `type: "permission_error"`
1919
1920 default: permission_error
1921
18991922 - `message: string`
19001923
19011924 default: Permission denied
19021925
1903 - `type: "permission_error"`
1904
1905 default: permission_error
1906
19071926 - `BetaNotFoundError object`
19081927
1928 - `type: "not_found_error"`
1929
1930 default: not_found_error
1931
19091932 - `message: string`
19101933
19111934 default: Not found
19121935
1913 - `type: "not_found_error"`
1914
1915 default: not_found_error
1916
19171936 - `BetaRateLimitError object`
19181937
1938 - `type: "rate_limit_error"`
1939
1940 default: rate_limit_error
1941
19191942 - `message: string`
19201943
19211944 default: Rate limited
19221945
1923 - `type: "rate_limit_error"`
1924
1925 default: rate_limit_error
1926
19271946 - `BetaGatewayTimeoutError object`
19281947
1948 - `type: "timeout_error"`
1949
1950 default: timeout_error
1951
19291952 - `message: string`
19301953
19311954 default: Request timeout
19321955
1933 - `type: "timeout_error"`
1934
1935 default: timeout_error
1936
19371956 - `BetaAPIError object`
19381957
1958 - `type: "api_error"`
1959
1960 default: api_error
1961
19391962 - `message: string`
19401963
19411964 default: Internal server error
19421965
1943 - `type: "api_error"`
1944
1945 default: api_error
1946
19471966 - `BetaOverloadedError object`
19481967
1968 - `type: "overloaded_error"`
1969
1970 default: overloaded_error
1971
19491972 - `message: string`
19501973
19511974 default: Overloaded
19521975
1953 - `type: "overloaded_error"`
1954
1955 default: overloaded_error
1956
19571976 - `request_id: string or null`
1958
1959 - `type: "error"`
1960
1961 default: error
1962
1963 - `type: "errored"`
1964
1965 default: errored
19661977
19671978 - `BetaMessageBatchCanceledResult object`
19681979
19691980