What this read moved
476–500 of 519This capture is too large to show at once. Changes 476-500 of 519 are below, significant first; the rest are on the following screens.
api/compliance/organizations/roles/permissions/list Changed · +11 / -0 lines
from line 1
1---
2title: List Compliance Role Permissions
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/permissions/list
4---
5
16# List Compliance Role Permissions
27
38**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}/permissions`
from line 32
2732 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.
2833
2934## Headers
35
36- `"anthropic-version": optional string`
37
38 The version of the Claude API you want to use.
39
40 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3041
3142- `"x-api-key": optional string`
3243
api/compliance/organizations/roles/retrieve Changed · +19 / -4 lines
from line 1
1---
2title: Get Compliance Role
3url: https://platform.claude.com/docs/en/api/compliance/organizations/roles/retrieve
4---
5
16# Get Compliance Role
27
38**GET** `/v1/compliance/organizations/{org_uuid}/roles/{role_id}`
from line 21
1621
1722## Headers
1823
24- `"anthropic-version": optional string`
25
26 The version of the Claude API you want to use.
27
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
29
1930- `"x-api-key": optional string`
2031
2132## Returns
from line 37
2637
2738- `created_at: string or null`
2839
29 Role creation timestamp (ISO 8601)
40 Role creation timestamp (RFC 3339)
3041
42 format: date-time
43
3144- `description: string`
3245
3346 Role description
from line 51
3851
3952- `updated_at: string or null`
4053
41 Role last-updated timestamp (ISO 8601)
54 Role last-updated timestamp (RFC 3339)
4255
56 format: date-time
57
4358## Example
4459
4560```bash
from line 67
5267```json
5368{
5469 "id": "rbac_role_01SGBg3kEnZrdsVR2QmyJbvD",
55 "created_at": "2025-03-12T18:22:41.123456",
70 "created_at": "2025-03-12T18:22:41.123456Z",
5671 "description": "Full administrative access to organization settings and members",
5772 "name": "Organization Admin",
58 "updated_at": "2025-03-14T09:05:17.456789"
73 "updated_at": "2025-03-14T09:05:17.456789Z"
5974}
6075```
6176
api/compliance/organizations/settings Changed · +89 / -74 lines
from line 1
1---
2title: Settings
3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings
4---
5
16# Settings
27
38## Get effective organization settings
from line 28
2328
2429### Headers
2530
31- `"anthropic-version": optional string`
32
33 The version of the Claude API you want to use.
34
35 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
36
2637- `"x-api-key": optional string`
2738
2839### Returns
2940
41- `type: optional "effective_organization_settings"`
42
43 default: effective_organization_settings
44
3045- `api_keys: array of object`
3146
3247 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
3348
49 - `type: optional "compliance_api_key"`
50
51 default: compliance_api_key
52
3453 - `id: string`
3554
3655 Unique identifier for the API key.
from line 82
6382
6483 format: date-time
6584
66 - `type: optional "compliance_api_key"`
67
68 default: compliance_api_key
69
7085- `organization_id: string`
7186
7287- `settings: array of object or object or object or 3 more`
from line 90
7590
7691 A setting whose enforced value is a single true/false flag.
7792
78 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
93 - `type: optional "boolean"`
7994
95 default: boolean
96
97 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
98
8099 - `"ai_powered_artifacts_enabled"`
81100
82101 - `"api_workbench_feedback_collection_enabled"`
from line 112
93112
94113 - `"claude_ai_integration_sharing_enabled"`
95114
115 - `"claude_ai_skill_plugins_scanning_enabled"`
116
96117 - `"claude_code_desktop_bypass_permissions_enabled"`
97118
98119 - `"claude_code_desktop_enabled"`
from line 210
189210
190211 - `value: boolean`
191212
192 - `type: optional "boolean"`
193
194 default: boolean
195
196213 - `Integer object`
197214
198215 A setting whose enforced value is a whole number; null means no limit
199216 is in force.
200217
201 - `name: "account_session_duration_seconds"`
202
203 - `value: number or null`
204
205218 - `type: optional "integer"`
206219
207220 default: integer
208221
222 - `name: "account_session_duration_seconds"`
223
224 - `value: number or null`
225
209226 - `String object`
210227
211228 A setting whose enforced value is a single string; null means no value
212229 is configured.
213230
231 - `type: optional "string"`
232
233 default: string
234
214235 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
215236
216237 - `"claude_code_default_worker_environment_id"`
from line 240
219240
220241 - `value: string or null`
221242
222 - `type: optional "string"`
223
224 default: string
225
226243 - `StringList object`
227244
228245 A setting whose enforced value is a list of strings.
229246
247 - `type: optional "string_list"`
248
249 default: string_list
250
230251 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
231252
232253 - `"allowed_invite_domains"`
from line 258
237258
238259 - `value: array of string`
239260
240 - `type: optional "string_list"`
241
242 default: string_list
243
244261 - `ProvisioningMode object`
245262
246263 How organization members are provisioned, resolved to the enforced mode.
from line 267
250267 modes require directory sync to be enabled. Otherwise `login_only` is
251268 reported, regardless of any stored configuration.
252269
270 - `type: optional "provisioning_mode"`
271
272 default: provisioning_mode
273
253274 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
254275
255276 How organization members are provisioned under SSO.
from line 289
268289
269290 default: sso_provisioning_mode
270291
271 - `type: optional "provisioning_mode"`
272
273 default: provisioning_mode
274
275292 - `DataRetention object`
276293
277294 The data retention periods in force, keyed by the type of data they
from line 299
282299 administrator-configured retention period is in force for that data type;
283300 Anthropic's service defaults may still apply.
284301
302 - `type: optional "data_retention"`
303
304 default: data_retention
305
285306 - `value: map[object or object]`
286307
287308 - `Fixed object`
from line 309
288309
289310 A fixed retention window measured from each item's last activity.
290311
312 - `type: optional "fixed"`
313
314 default: fixed
315
291316 - `duration: number`
292317
293318 - `timescale: "day" or "month"`
from line 321
296321
297322 - `"month"`
298323
299 - `type: optional "fixed"`
300
301 default: fixed
302
303324 - `Indefinite object`
304325
305326 An indefinite retention period: data is kept with no time limit.
from line 333
312333
313334 default: data_retention_periods
314335
315 - `type: optional "data_retention"`
316
317 default: data_retention
318
319- `type: optional "effective_organization_settings"`
320
321 default: effective_organization_settings
322
323336### Example
324337
325338```bash
from line 383
370383 cannot change — for example, one controlled by Anthropic policy or not
371384 available to the organization — is omitted from the list.
372385
386 - `type: optional "effective_organization_settings"`
387
388 default: effective_organization_settings
389
373390 - `api_keys: array of object`
374391
375392 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
376393
394 - `type: optional "compliance_api_key"`
395
396 default: compliance_api_key
397
377398 - `id: string`
378399
379400 Unique identifier for the API key.
from line 427
406427
407428 format: date-time
408429
409 - `type: optional "compliance_api_key"`
410
411 default: compliance_api_key
412
413430 - `organization_id: string`
414431
415432 - `settings: array of object or object or object or 3 more`
from line 435
418435
419436 A setting whose enforced value is a single true/false flag.
420437
421 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
438 - `type: optional "boolean"`
422439
440 default: boolean
441
442 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
443
423444 - `"ai_powered_artifacts_enabled"`
424445
425446 - `"api_workbench_feedback_collection_enabled"`
from line 457
436457
437458 - `"claude_ai_integration_sharing_enabled"`
438459
460 - `"claude_ai_skill_plugins_scanning_enabled"`
461
439462 - `"claude_code_desktop_bypass_permissions_enabled"`
440463
441464 - `"claude_code_desktop_enabled"`
from line 555
532555
533556 - `value: boolean`
534557
535 - `type: optional "boolean"`
536
537 default: boolean
538
539558 - `Integer object`
540559
541560 A setting whose enforced value is a whole number; null means no limit
542561 is in force.
543562
544 - `name: "account_session_duration_seconds"`
545
546 - `value: number or null`
547
548563 - `type: optional "integer"`
549564
550565 default: integer
551566
567 - `name: "account_session_duration_seconds"`
568
569 - `value: number or null`
570
552571 - `String object`
553572
554573 A setting whose enforced value is a single string; null means no value
555574 is configured.
556575
576 - `type: optional "string"`
577
578 default: string
579
557580 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
558581
559582 - `"claude_code_default_worker_environment_id"`
from line 585
562585
563586 - `value: string or null`
564587
565 - `type: optional "string"`
566
567 default: string
568
569588 - `StringList object`
570589
571590 A setting whose enforced value is a list of strings.
572591
592 - `type: optional "string_list"`
593
594 default: string_list
595
573596 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
574597
575598 - `"allowed_invite_domains"`
from line 603
580603
581604 - `value: array of string`
582605
583 - `type: optional "string_list"`
584
585 default: string_list
586
587606 - `ProvisioningMode object`
588607
589608 How organization members are provisioned, resolved to the enforced mode.
from line 612
593612 modes require directory sync to be enabled. Otherwise `login_only` is
594613 reported, regardless of any stored configuration.
595614
615 - `type: optional "provisioning_mode"`
616
617 default: provisioning_mode
618
596619 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
597620
598621 How organization members are provisioned under SSO.
from line 634
611634
612635 default: sso_provisioning_mode
613636
614 - `type: optional "provisioning_mode"`
615
616 default: provisioning_mode
617
618637 - `DataRetention object`
619638
620639 The data retention periods in force, keyed by the type of data they
from line 644
625644 administrator-configured retention period is in force for that data type;
626645 Anthropic's service defaults may still apply.
627646
647 - `type: optional "data_retention"`
648
649 default: data_retention
650
628651 - `value: map[object or object]`
629652
630653 - `Fixed object`
from line 654
631654
632655 A fixed retention window measured from each item's last activity.
633656
657 - `type: optional "fixed"`
658
659 default: fixed
660
634661 - `duration: number`
635662
636663 - `timescale: "day" or "month"`
from line 666
639666
640667 - `"month"`
641668
642 - `type: optional "fixed"`
643
644 default: fixed
645
646669 - `Indefinite object`
647670
648671 An indefinite retention period: data is kept with no time limit.
from line 677
654677 - `name: optional "data_retention_periods"`
655678
656679 default: data_retention_periods
657
658 - `type: optional "data_retention"`
659
660 default: data_retention
661
662 - `type: optional "effective_organization_settings"`
663
664 default: effective_organization_settings
665680
api/compliance/organizations/settings/retrieve Changed · +50 / -37 lines
from line 1
1---
2title: Get effective organization settings
3url: https://platform.claude.com/docs/en/api/compliance/organizations/settings/retrieve
4---
5
16# Get effective organization settings
27
38**GET** `/v1/compliance/organizations/{organization_id}/settings`
from line 26
2126
2227## Headers
2328
29- `"anthropic-version": optional string`
30
31 The version of the Claude API you want to use.
32
33 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
34
2435- `"x-api-key": optional string`
2536
2637## Returns
2738
39- `type: optional "effective_organization_settings"`
40
41 default: effective_organization_settings
42
2843- `api_keys: array of object`
2944
3045 Compliance API keys configured for the organization hierarchy, ordered by creation time ascending. Key secret values are never included.
3146
47 - `type: optional "compliance_api_key"`
48
49 default: compliance_api_key
50
3251 - `id: string`
3352
3453 Unique identifier for the API key.
from line 80
6180
6281 format: date-time
6382
64 - `type: optional "compliance_api_key"`
65
66 default: compliance_api_key
67
6883- `organization_id: string`
6984
7085- `settings: array of object or object or object or 3 more`
from line 88
7388
7489 A setting whose enforced value is a single true/false flag.
7590
76 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 52 more`
91 - `type: optional "boolean"`
7792
93 default: boolean
94
95 - `name: "ai_powered_artifacts_enabled" or "api_workbench_feedback_collection_enabled" or "artifact_connectors_enabled" or 53 more`
96
7897 - `"ai_powered_artifacts_enabled"`
7998
8099 - `"api_workbench_feedback_collection_enabled"`
from line 110
91110
92111 - `"claude_ai_integration_sharing_enabled"`
93112
113 - `"claude_ai_skill_plugins_scanning_enabled"`
114
94115 - `"claude_code_desktop_bypass_permissions_enabled"`
95116
96117 - `"claude_code_desktop_enabled"`
from line 208
187208
188209 - `value: boolean`
189210
190 - `type: optional "boolean"`
191
192 default: boolean
193
194211 - `Integer object`
195212
196213 A setting whose enforced value is a whole number; null means no limit
197214 is in force.
198215
199 - `name: "account_session_duration_seconds"`
200
201 - `value: number or null`
202
203216 - `type: optional "integer"`
204217
205218 default: integer
206219
220 - `name: "account_session_duration_seconds"`
221
222 - `value: number or null`
223
207224 - `String object`
208225
209226 A setting whose enforced value is a single string; null means no value
210227 is configured.
211228
229 - `type: optional "string"`
230
231 default: string
232
212233 - `name: "claude_code_default_worker_environment_id" or "claude_code_default_worker_pool_id"`
213234
214235 - `"claude_code_default_worker_environment_id"`
from line 238
217238
218239 - `value: string or null`
219240
220 - `type: optional "string"`
221
222 default: string
223
224241 - `StringList object`
225242
226243 A setting whose enforced value is a list of strings.
227244
245 - `type: optional "string_list"`
246
247 default: string_list
248
228249 - `name: "allowed_invite_domains" or "disabled_admin_request_types" or "ip_allowlist_ip_ranges"`
229250
230251 - `"allowed_invite_domains"`
from line 256
235256
236257 - `value: array of string`
237258
238 - `type: optional "string_list"`
239
240 default: string_list
241
242259 - `ProvisioningMode object`
243260
244261 How organization members are provisioned, resolved to the enforced mode.
from line 265
248265 modes require directory sync to be enabled. Otherwise `login_only` is
249266 reported, regardless of any stored configuration.
250267
268 - `type: optional "provisioning_mode"`
269
270 default: provisioning_mode
271
251272 - `value: "jit_advanced" or "jit_permissive" or "login_only" or 2 more`
252273
253274 How organization members are provisioned under SSO.
from line 287
266287
267288 default: sso_provisioning_mode
268289
269 - `type: optional "provisioning_mode"`
270
271 default: provisioning_mode
272
273290 - `DataRetention object`
274291
275292 The data retention periods in force, keyed by the type of data they
from line 297
280297 administrator-configured retention period is in force for that data type;
281298 Anthropic's service defaults may still apply.
282299
300 - `type: optional "data_retention"`
301
302 default: data_retention
303
283304 - `value: map[object or object]`
284305
285306 - `Fixed object`
from line 307
286307
287308 A fixed retention window measured from each item's last activity.
288309
310 - `type: optional "fixed"`
311
312 default: fixed
313
289314 - `duration: number`
290315
291316 - `timescale: "day" or "month"`
from line 319
294319
295320 - `"month"`
296321
297 - `type: optional "fixed"`
298
299 default: fixed
300
301322 - `Indefinite object`
302323
303324 An indefinite retention period: data is kept with no time limit.
from line 330
309330 - `name: optional "data_retention_periods"`
310331
311332 default: data_retention_periods
312
313 - `type: optional "data_retention"`
314
315 default: data_retention
316
317- `type: optional "effective_organization_settings"`
318
319 default: effective_organization_settings
320333
321334## Example
322335
api/compliance/organizations/users Changed · +11 / -0 lines
from line 1
1---
2title: Users
3url: https://platform.claude.com/docs/en/api/compliance/organizations/users
4---
5
16# Users
27
38## List organization users
from line 30
2530 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.
2631
2732### Headers
33
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).
2839
2940- `"x-api-key": optional string`
3041
api/compliance/organizations/users/list Changed · +11 / -0 lines
from line 1
1---
2title: List organization users
3url: https://platform.claude.com/docs/en/api/compliance/organizations/users/list
4---
5
16# List organization users
27
38**GET** `/v1/compliance/organizations/{org_uuid}/users`
from line 28
2328 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.
2429
2530## Headers
31
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).
2637
2738- `"x-api-key": optional string`
2839
api/files Changed · +66 / -41 lines
### Headers ### Headers ### Headers ### Headers ### Headers
from line 1
1---
2title: Files
3url: https://platform.claude.com/docs/en/api/files
4---
5
16# Files
27
38## Upload File
from line 11
611
712Upload File
813
14### Headers
15
16- `"anthropic-workspace-id": optional string`
17
918### Body parameters (form-data)
1019
1120- `file: string`
1221
13 The file to upload
22 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.
1423
1524 format: binary
1625
from line 33
2433
2534- `FileMetadata object`
2635
36 - `type: "file"`
37
38 Object type.
39
40 For files, this is always `"file"`.
41
2742 - `id: string`
2843
2944 Unique object identifier.
from line 69
5469
5570 minimum: 0
5671
57 - `type: "file"`
58
59 Object type.
60
61 For files, this is always `"file"`.
62
6372 - `downloadable: optional boolean`
6473
6574 Whether the file can be downloaded.
from line 130
121130
122131 Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`.
123132
133### Headers
134
135- `"anthropic-workspace-id": optional string`
136
124137### Returns
125138
126139- `data: array of FileMetadata`
from line 140
127140
128141 List of file metadata objects.
129142
143 - `type: "file"`
144
145 Object type.
146
147 For files, this is always `"file"`.
148
130149 - `id: string`
131150
132151 Unique object identifier.
from line 176
157176
158177 minimum: 0
159178
160 - `type: "file"`
161
162 Object type.
163
164 For files, this is always `"file"`.
165
166179 - `downloadable: optional boolean`
167180
168181 Whether the file can be downloaded.
from line 232
219232
220233 ID of the File.
221234
235### Headers
236
237- `"anthropic-workspace-id": optional string`
238
222239### Example
223240
224241```bash
from line 256
239256
240257 ID of the File.
241258
259### Headers
260
261- `"anthropic-workspace-id": optional string`
262
242263### Returns
243264
244265- `FileMetadata object`
245266
267 - `type: "file"`
268
269 Object type.
270
271 For files, this is always `"file"`.
272
246273 - `id: string`
247274
248275 Unique object identifier.
from line 300
273300
274301 minimum: 0
275302
276 - `type: "file"`
277
278 Object type.
279
280 For files, this is always `"file"`.
281
282303 - `downloadable: optional boolean`
283304
284305 Whether the file can be downloaded.
from line 347
326347
327348 ID of the File.
328349
350### Headers
351
352- `"anthropic-workspace-id": optional string`
353
329354### Returns
330355
331356- `DeletedFile object`
332357
333 - `id: string`
334
335 ID of the deleted file.
336
337358 - `type: optional "file_deleted"`
338359
339360 Deleted object type.
from line 363
342363
343364 default: file_deleted
344365
366 - `id: string`
367
368 ID of the deleted file.
369
345370### Example
346371
347372```bash
from line 391
366391
367392- `DeletedFile object`
368393
369 - `id: string`
370
371 ID of the deleted file.
372
373394 - `type: optional "file_deleted"`
374395
375396 Deleted object type.
from line 399
378399
379400 default: file_deleted
380401
402 - `id: string`
403
404 ID of the deleted file.
405
381406### File Metadata
382407
383408- `FileMetadata object`
384409
410 - `type: "file"`
411
412 Object type.
413
414 For files, this is always `"file"`.
415
385416 - `id: string`
386417
387418 Unique object identifier.
from line 442
411442 Size of the file in bytes.
412443
413444 minimum: 0
414
415 - `type: "file"`
416
417 Object type.
418
419 For files, this is always `"file"`.
420445
421446 - `downloadable: optional boolean`
422447
api/files/delete Changed · +13 / -4 lines
## Headers
from line 1
1---
2title: Delete File
3url: https://platform.claude.com/docs/en/api/files/delete
4---
5
16# Delete File
27
38**DELETE** `/v1/files/{file_id}`
from line 15
1015
1116 ID of the File.
1217
18## Headers
19
20- `"anthropic-workspace-id": optional string`
21
1322## Returns
1423
1524- `DeletedFile object`
1625
17 - `id: string`
18
19 ID of the deleted file.
20
2126 - `type: optional "file_deleted"`
2227
2328 Deleted object type.
from line 30
2530 For file deletion, this is always `"file_deleted"`.
2631
2732 default: file_deleted
33
34 - `id: string`
35
36 ID of the deleted file.
2837
2938## Example
3039
api/files/download Changed · +9 / -0 lines
## Headers
from line 1
1---
2title: Download File
3url: https://platform.claude.com/docs/en/api/files/download
4---
5
16# Download File
27
38**GET** `/v1/files/{file_id}/content`
from line 14
914- `file_id: string`
1015
1116 ID of the File.
17
18## Headers
19
20- `"anthropic-workspace-id": optional string`
1221
1322## Example
1423
api/files/list Changed · +15 / -6 lines
## Headers
from line 1
1---
2title: List Files
3url: https://platform.claude.com/docs/en/api/files/list
4---
5
16# List Files
27
38**GET** `/v1/files`
from line 27
2227
2328 Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`.
2429
30## Headers
31
32- `"anthropic-workspace-id": optional string`
33
2534## Returns
2635
2736- `data: array of FileMetadata`
from line 37
2837
2938 List of file metadata objects.
3039
40 - `type: "file"`
41
42 Object type.
43
44 For files, this is always `"file"`.
45
3146 - `id: string`
3247
3348 Unique object identifier.
from line 72
5772 Size of the file in bytes.
5873
5974 minimum: 0
60
61 - `type: "file"`
62
63 Object type.
64
65 For files, this is always `"file"`.
6675
6776 - `downloadable: optional boolean`
6877
api/files/retrieve_metadata Changed · +15 / -6 lines
## Headers
from line 1
1---
2title: Get File Metadata
3url: https://platform.claude.com/docs/en/api/files/retrieve_metadata
4---
5
16# Get File Metadata
27
38**GET** `/v1/files/{file_id}`
from line 15
1015
1116 ID of the File.
1217
18## Headers
19
20- `"anthropic-workspace-id": optional string`
21
1322## Returns
1423
1524- `FileMetadata object`
1625
26 - `type: "file"`
27
28 Object type.
29
30 For files, this is always `"file"`.
31
1732 - `id: string`
1833
1934 Unique object identifier.
from line 58
4358 Size of the file in bytes.
4459
4560 minimum: 0
46
47 - `type: "file"`
48
49 Object type.
50
51 For files, this is always `"file"`.
5261
5362 - `downloadable: optional boolean`
5463
api/files/upload Changed · +16 / -7 lines
## Headers
from line 1
1---
2title: Upload File
3url: https://platform.claude.com/docs/en/api/files/upload
4---
5
16# Upload File
27
38**POST** `/v1/files`
from line 9
49
510Upload File
611
12## Headers
13
14- `"anthropic-workspace-id": optional string`
15
716## Body parameters (form-data)
817
918- `file: string`
1019
11 The file to upload
20 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.
1221
1322 format: binary
1423
from line 31
2231
2332- `FileMetadata object`
2433
34 - `type: "file"`
35
36 Object type.
37
38 For files, this is always `"file"`.
39
2540 - `id: string`
2641
2742 Unique object identifier.
from line 66
5166 Size of the file in bytes.
5267
5368 minimum: 0
54
55 - `type: "file"`
56
57 Object type.
58
59 For files, this is always `"file"`.
6069
6170 - `downloadable: optional boolean`
6271
api/messages Changed · +7368 / -7303 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
Nothing in the body moved in this read. What changed is above.
api/messages/batches Changed · +1865 / -1828 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: Batches
3url: https://platform.claude.com/docs/en/api/messages/batches
4---
5
16# Batches
27
38## Create a Message Batch
from line 20
1520- `"anthropic-user-profile-id": optional string`
1621
1722 The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored.
23
24- `"anthropic-workspace-id": optional string`
1825
1926### Body parameters
2027
from line 116
109116
110117 - `TextBlockParam object`
111118
119 - `type: "text"`
120
112121 - `text: string`
113122
114123 minLength: 1
115
116 - `type: "text"`
117124
118125 - `cache_control: optional CacheControlEphemeral or null`
119126
from line 147
140147
141148 - `CitationCharLocationParam object`
142149
150 - `type: "char_location"`
151
143152 - `cited_text: string`
144153
145154 - `document_index: number`
from line 165
156165
157166 minimum: 0
158167
159 - `type: "char_location"`
160
161168 - `CitationPageLocationParam object`
162169
170 - `type: "page_location"`
171
163172 - `cited_text: string`
164173
165174 - `document_index: number`
from line 185
176185
177186 minimum: 1
178187
179 - `type: "page_location"`
180
181188 - `CitationContentBlockLocationParam object`
182189
190 - `type: "content_block_location"`
191
183192 - `cited_text: string`
184193
185194 The full text of the cited block range, concatenated.
from line 215
206215
207216 minimum: 0
208217
209 - `type: "content_block_location"`
210
211218 - `CitationWebSearchResultLocationParam object`
212219
220 - `type: "web_search_result_location"`
221
213222 - `cited_text: string`
214223
215224 - `encrypted_index: string`
from line 227
218227
219228 maxLength: 512, minLength: 1
220229
221 - `type: "web_search_result_location"`
222
223230 - `url: string`
224231
225232 minLength: 1
226233
227234 - `CitationSearchResultLocationParam object`
228235
236 - `type: "search_result_location"`
237
229238 - `cited_text: string`
230239
231240 The full text of the cited block range, concatenated.
from line 265
256265
257266 - `title: string or null`
258267
259 - `type: "search_result_location"`
260
261268 - `ImageBlockParam object`
262269
270 - `type: "image"`
271
263272 - `source: Base64ImageSource or URLImageSource or FileImageSource`
264273
265274 - `Base64ImageSource object`
266275
276 - `type: "base64"`
277
267278 - `data: string`
268279
269280 format: byte
from line 289
278289
279290 - `"image/webp"`
280291
292 - `URLImageSource object`
293
294 - `type: "url"`
295
296 - `url: string`
297
298 - `FileImageSource object`
299
300 - `type: "file"`
301
302 - `file_id: string`
303
304 - `cache_control: optional CacheControlEphemeral or null`
305
306 Create a cache control breakpoint at this content block.
307
308 - `transformations: optional ImageTransformationsParam or null`
309
310 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
311
312 - `oversized_image: optional "downsize" or "error"`
313
314 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
315
316 - `"downsize"`
317
318 - `"error"`
319
320 - `DocumentBlockParam object`
321
322 - `type: "document"`
323
324 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
325
326 - `Base64PDFSource object`
327
281328 - `type: "base64"`
282329
283 - `URLImageSource object`
330 - `data: string`
331
332 format: byte
333
334 - `media_type: "application/pdf"`
335
336 - `PlainTextSource object`
337
338 - `type: "text"`
339
340 - `data: string`
341
342 - `media_type: "text/plain"`
343
344 - `ContentBlockSource object`
345
346 - `type: "content"`
347
348 - `content: string or array of ContentBlockSourceContent`
349
350 - `string`
351
352 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
353
354 - `TextBlockParam object`
355
356 - `ImageBlockParam object`
357
358 - `URLPDFSource object`
284359
285360 - `type: "url"`
286361
287362 - `url: string`
288363
289 - `FileImageSource object`
364 - `FileDocumentSource object`
365
366 - `type: "file"`
290367
291368 - `file_id: string`
292369
293 - `type: "file"`
294
295 - `type: "image"`
296
297370 - `cache_control: optional CacheControlEphemeral or null`
298371
299372 Create a cache control breakpoint at this content block.
300373
301 - `transformations: optional ImageTransformationsParam or null`
302
303 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
304
305 - `oversized_image: optional "downsize" or "error"`
306
307 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
308
309 - `"downsize"`
310
311 - `"error"`
312
313 - `DocumentBlockParam object`
314
315 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
316
317 - `Base64PDFSource object`
318
319 - `data: string`
320
321 format: byte
322
323 - `media_type: "application/pdf"`
324
325 - `type: "base64"`
326
327 - `PlainTextSource object`
328
329 - `data: string`
330
331 - `media_type: "text/plain"`
332
333 - `type: "text"`
334
335 - `ContentBlockSource object`
336
337 - `content: string or array of ContentBlockSourceContent`
338
339 - `string`
340
341 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
342
343 - `TextBlockParam object`
344
345 - `ImageBlockParam object`
346
347 - `type: "content"`
348
349 - `URLPDFSource object`
350
351 - `type: "url"`
352
353 - `url: string`
354
355 - `FileDocumentSource object`
356
357 - `file_id: string`
358
359 - `type: "file"`
360
361 - `type: "document"`
374 - `citations: optional CitationsConfigParam or null`
375
376 - `enabled: optional boolean`
377
378 - `context: optional string or null`
379
380 minLength: 1
381
382 - `title: optional string or null`
383
384 maxLength: 500, minLength: 1
385
386 - `SearchResultBlockParam object`
387
388 - `type: "search_result"`
389
390 - `content: array of TextBlockParam`
391
392 - `type: "text"`
393
394 - `text: string`
395
396 minLength: 1
397
398 - `cache_control: optional CacheControlEphemeral or null`
399
400 Create a cache control breakpoint at this content block.
401
402 - `citations: optional array of TextCitationParam or null`
403
404 - `source: string`
405
406 - `title: string`
362407
363408 - `cache_control: optional CacheControlEphemeral or null`
364409
365410 Create a cache control breakpoint at this content block.
366411
367 - `citations: optional CitationsConfigParam or null`
368
369 - `enabled: optional boolean`
370
371 - `context: optional string or null`
372
373 minLength: 1
374
375 - `title: optional string or null`
376
377 maxLength: 500, minLength: 1
378
379 - `SearchResultBlockParam object`
380
381 - `content: array of TextBlockParam`
382
383 - `text: string`
384
385 minLength: 1
386
387 - `type: "text"`
388
389 - `cache_control: optional CacheControlEphemeral or null`
390
391 Create a cache control breakpoint at this content block.
392
393 - `citations: optional array of TextCitationParam or null`
394
395 - `source: string`
396
397 - `title: string`
398
399 - `type: "search_result"`
412 - `citations: optional CitationsConfigParam`
413
414 - `ThinkingBlockParam object`
415
416 - `type: "thinking"`
417
418 - `signature: string`
419
420 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
421
422 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
423
424 - `thinking: string`
425
426 The `thinking` text of this block as returned by the API.
427
428 - `RedactedThinkingBlockParam object`
429
430 - `type: "redacted_thinking"`
431
432 - `data: string`
433
434 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
435
436 - `ToolUseBlockParam object`
437
438 - `type: "tool_use"`
439
440 - `id: string`
441
442 pattern: ^[a-zA-Z0-9_-]+$
443
444 - `input: map[unknown]`
445
446 - `name: string`
447
448 maxLength: 200, minLength: 1
400449
401450 - `cache_control: optional CacheControlEphemeral or null`
402451
403452 Create a cache control breakpoint at this content block.
404453
405 - `citations: optional CitationsConfigParam`
406
407 - `ThinkingBlockParam object`
408
409 - `signature: string`
410
411 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
412
413 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
414
415 - `thinking: string`
416
417 The `thinking` text of this block as returned by the API.
418
419 - `type: "thinking"`
420
421 - `RedactedThinkingBlockParam object`
422
423 - `data: string`
424
425 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
426
427 - `type: "redacted_thinking"`
428
429 - `ToolUseBlockParam object`
430
431 - `id: string`
454 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
455
456 Tool invocation directly from the model.
457
458 - `DirectCaller object`
459
460 Tool invocation directly from the model.
461
462 - `type: "direct"`
463
464 - `ServerToolCaller object`
465
466 Tool invocation generated by a server-side tool.
467
468 - `type: "code_execution_20250825"`
469
470 - `tool_id: string`
471
472 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
473
474 - `ServerToolCaller20260120 object`
475
476 - `type: "code_execution_20260120"`
477
478 - `tool_id: string`
479
480 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
481
482 - `toolset_name: optional string or null`
483
484 For a toolset member tool_use, the toolset family this member belongs to.
485
486 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
487
488 - `ToolResultBlockParam object`
489
490 - `type: "tool_result"`
491
492 - `tool_use_id: string`
432493
433494 pattern: ^[a-zA-Z0-9_-]+$
434495
435 - `input: map[unknown]`
436
437 - `name: string`
438
439 maxLength: 200, minLength: 1
440
441 - `type: "tool_use"`
442
443496 - `cache_control: optional CacheControlEphemeral or null`
444497
445498 Create a cache control breakpoint at this content block.
446499
447 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
448
449 Tool invocation directly from the model.
450
451 - `DirectCaller object`
452
453 Tool invocation directly from the model.
454
455 - `type: "direct"`
456
457 - `ServerToolCaller object`
458
459 Tool invocation generated by a server-side tool.
460
461 - `tool_id: string`
462
463 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
464
465 - `type: "code_execution_20250825"`
466
467 - `ServerToolCaller20260120 object`
468
469 - `tool_id: string`
470
471 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
472
473 - `type: "code_execution_20260120"`
474
475 - `toolset_name: optional string or null`
476
477 For a toolset member tool_use, the toolset family this member belongs to.
478
479 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
480
481 - `ToolResultBlockParam object`
482
483 - `tool_use_id: string`
484
485 pattern: ^[a-zA-Z0-9_-]+$
486
487 - `type: "tool_result"`
488
489 - `cache_control: optional CacheControlEphemeral or null`
490
491 Create a cache control breakpoint at this content block.
492
493500 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`
494501
495502 - `string`
from line 515
508515
509516 Tool reference block that can be included in tool_result content.
510517
518 - `type: "tool_reference"`
519
511520 - `tool_name: string`
512521
513522 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
514
515 - `type: "tool_reference"`
516523
517524 - `cache_control: optional CacheControlEphemeral or null`
518525
from line 535
528535 browser toolset member `tool_use`. The server renders the
529536 model-visible text from it; the model never sees the raw fields.
530537
538 - `type: "browser_state"`
539
531540 - `tabs: array of BrowserStateTabEntry`
532541
533542 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
from line 564
555564 - `active: optional boolean`
556565
557566 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
558
559 - `type: "browser_state"`
560567
561568 - `cache_control: optional CacheControlEphemeral or null`
562569
from line 585
578585 during a failed call gets no deferred `tab_opened`; it simply appears
579586 in the next result's `tabs` inventory.
580587
588 - `type: "tab_opened"`
589
581590 - `tab_id: string`
582591
583592 The `tab_id` of the opened tab, present in `tabs`.
584593
585594 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
586595
587 - `type: "tab_opened"`
588
589596 - `BrowserStateChangeDownloadStarted object`
590597
591598 A file download that started during this call.
592599
600 - `type: "download_started"`
601
593602 - `download_id: string`
594603
595604 The caller-assigned identifier for this download, stable across the state changes reporting it.
596605
597606 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
598
599 - `type: "download_started"`
600607
601608 - `url: string`
602609
from line 618
611618 `download_started`, when the download finished during the call that
612619 started it (at most one state change per `download_id` per result).
613620
621 - `type: "download_completed"`
622
614623 - `download_id: string`
615624
616625 The caller-assigned identifier for this download, stable across the state changes reporting it.
617626
618627 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
619628
620 - `type: "download_completed"`
621
622629 - `url: string`
623630
624631 The final post-redirect URL the download was served from.
from line 648
641648
642649 A file download that failed — or was cancelled — during this call.
643650
651 - `type: "download_failed"`
652
644653 - `download_id: string`
645654
646655 The caller-assigned identifier for this download, stable across the state changes reporting it.
647656
648657 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
649658
650 - `type: "download_failed"`
651
652659 - `url: string`
653660
654661 The final post-redirect URL the download was served from.
from line 678
671678
672679 - `ServerToolUseBlockParam object`
673680
681 - `type: "server_tool_use"`
682
674683 - `id: string`
675684
676685 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 702
693702
694703 - `"tool_search_tool_bm25"`
695704
696 - `type: "server_tool_use"`
697
698705 - `cache_control: optional CacheControlEphemeral or null`
699706
700707 Create a cache control breakpoint at this content block.
from line 722
715722
716723 - `WebSearchToolResultBlockParam object`
717724
725 - `type: "web_search_tool_result"`
726
718727 - `content: WebSearchToolResultBlockParamContent`
719728
720729 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`
721730
731 - `type: "web_search_result"`
732
722733 - `encrypted_content: string`
723734
724735 - `title: string`
725736
726 - `type: "web_search_result"`
727
728737 - `url: string`
729738
730739 - `page_age: optional string or null`
731740
732741 - `WebSearchToolRequestError object`
733742
743 - `type: "web_search_tool_result_error"`
744
734745 - `error_code: WebSearchToolResultErrorCode`
735746
736747 - `"invalid_tool_input"`
from line 756
745756
746757 - `"request_too_large"`
747758
748 - `type: "web_search_tool_result_error"`
749
750759 - `tool_use_id: string`
751760
752761 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
753762
754 - `type: "web_search_tool_result"`
755
756763 - `cache_control: optional CacheControlEphemeral or null`
757764
758765 Create a cache control breakpoint at this content block.
from line 780
773780
774781 - `WebFetchToolResultBlockParam object`
775782
783 - `type: "web_fetch_tool_result"`
784
776785 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`
777786
778787 - `WebFetchToolResultErrorBlockParam object`
779788
789 - `type: "web_fetch_tool_result_error"`
790
780791 - `error_code: WebFetchToolResultErrorCode`
781792
782793 - `"invalid_tool_input"`
from line 808
797808
798809 - `"unavailable"`
799810
800 - `type: "web_fetch_tool_result_error"`
811 - `"content_too_large"`
801812
802813 - `WebFetchBlockParam object`
803814
815 - `type: "web_fetch_result"`
816
804817 - `content: DocumentBlockParam`
805818
806 - `type: "web_fetch_result"`
807
808819 - `url: string`
809820
810821 Fetched content URL
from line 828
817828
818829 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
819830
820 - `type: "web_fetch_tool_result"`
821
822831 - `cache_control: optional CacheControlEphemeral or null`
823832
824833 Create a cache control breakpoint at this content block.
from line 848
839848
840849 - `CodeExecutionToolResultBlockParam object`
841850
851 - `type: "code_execution_tool_result"`
852
842853 - `content: CodeExecutionToolResultBlockParamContent`
843854
844855 Code execution result with encrypted stdout for PFC + web_search results.
845856
846857 - `CodeExecutionToolResultErrorParam object`
847858
859 - `type: "code_execution_tool_result_error"`
860
848861 - `error_code: CodeExecutionToolResultErrorCode`
849862
850863 - `"invalid_tool_input"`
from line 868
855868
856869 - `"execution_time_exceeded"`
857870
858 - `type: "code_execution_tool_result_error"`
859
860871 - `CodeExecutionResultBlockParam object`
861872
873 - `type: "code_execution_result"`
874
862875 - `content: array of CodeExecutionOutputBlockParam`
863876
877 - `type: "code_execution_output"`
878
864879 - `file_id: string`
865880
881 - `return_code: number`
882
883 - `stderr: string`
884
885 - `stdout: string`
886
887 - `EncryptedCodeExecutionResultBlockParam object`
888
889 Code execution result with encrypted stdout for PFC + web_search results.
890
891 - `type: "encrypted_code_execution_result"`
892
893 - `content: array of CodeExecutionOutputBlockParam`
894
866895 - `type: "code_execution_output"`
867896
897 - `file_id: string`
898
899 - `encrypted_stdout: string`
900
868901 - `return_code: number`
869902
870903 - `stderr: string`
871904
905 - `tool_use_id: string`
906
907 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
908
909 - `cache_control: optional CacheControlEphemeral or null`
910
911 Create a cache control breakpoint at this content block.
912
913 - `BashCodeExecutionToolResultBlockParam object`
914
915 - `type: "bash_code_execution_tool_result"`
916
917 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
918
919 - `BashCodeExecutionToolResultErrorParam object`
920
921 - `type: "bash_code_execution_tool_result_error"`
922
923 - `error_code: BashCodeExecutionToolResultErrorCode`
924
925 - `"invalid_tool_input"`
926
927 - `"unavailable"`
928
929 - `"too_many_requests"`
930
931 - `"execution_time_exceeded"`
932
933 - `"output_file_too_large"`
934
935 - `BashCodeExecutionResultBlockParam object`
936
937 - `type: "bash_code_execution_result"`
938
939 - `content: array of BashCodeExecutionOutputBlockParam`
940
941 - `type: "bash_code_execution_output"`
942
943 - `file_id: string`
944
945 - `return_code: number`
946
947 - `stderr: string`
948
872949 - `stdout: string`
873950
874 - `type: "code_execution_result"`
875
876 - `EncryptedCodeExecutionResultBlockParam object`
877
878 Code execution result with encrypted stdout for PFC + web_search results.
879
880 - `content: array of CodeExecutionOutputBlockParam`
881
882 - `file_id: string`
883
884 - `type: "code_execution_output"`
885
886 - `encrypted_stdout: string`
887
888 - `return_code: number`
889
890 - `stderr: string`
891
892 - `type: "encrypted_code_execution_result"`
893
894951 - `tool_use_id: string`
895952
896953 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
897954
898 - `type: "code_execution_tool_result"`
899
900955 - `cache_control: optional CacheControlEphemeral or null`
901956
902957 Create a cache control breakpoint at this content block.
903958
904 - `BashCodeExecutionToolResultBlockParam object`
905
906 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
907
908 - `BashCodeExecutionToolResultErrorParam object`
909
910 - `error_code: BashCodeExecutionToolResultErrorCode`
959 - `TextEditorCodeExecutionToolResultBlockParam object`
960
961 - `type: "text_editor_code_execution_tool_result"`
962
963 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
964
965 - `TextEditorCodeExecutionToolResultErrorParam object`
966
967 - `type: "text_editor_code_execution_tool_result_error"`
968
969 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
911970
912971 - `"invalid_tool_input"`
913972
from line 976
917976
918977 - `"execution_time_exceeded"`
919978
920 - `"output_file_too_large"`
921
922 - `type: "bash_code_execution_tool_result_error"`
923
924 - `BashCodeExecutionResultBlockParam object`
925
926 - `content: array of BashCodeExecutionOutputBlockParam`
927
928 - `file_id: string`
929
930 - `type: "bash_code_execution_output"`
931
932 - `return_code: number`
933
934 - `stderr: string`
935
936 - `stdout: string`
937
938 - `type: "bash_code_execution_result"`
979 - `"file_not_found"`
980
981 - `error_message: optional string or null`
982
983 - `TextEditorCodeExecutionViewResultBlockParam object`
984
985 - `type: "text_editor_code_execution_view_result"`
986
987 - `content: string`
988
989 - `file_type: "text" or "image" or "pdf"`
990
991 - `"text"`
992
993 - `"image"`
994
995 - `"pdf"`
996
997 - `num_lines: optional number or null`
998
999 - `start_line: optional number or null`
1000
1001 - `total_lines: optional number or null`
1002
1003 - `TextEditorCodeExecutionCreateResultBlockParam object`
1004
1005 - `type: "text_editor_code_execution_create_result"`
1006
1007 - `is_file_update: boolean`
1008
1009 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
1010
1011 - `type: "text_editor_code_execution_str_replace_result"`
1012
1013 - `lines: optional array of string or null`
1014
1015 - `new_lines: optional number or null`
1016
1017 - `new_start: optional number or null`
1018
1019 - `old_lines: optional number or null`
1020
1021 - `old_start: optional number or null`
9391022
9401023 - `tool_use_id: string`
9411024
9421025 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
9431026
944 - `type: "bash_code_execution_tool_result"`
945
9461027 - `cache_control: optional CacheControlEphemeral or null`
9471028
9481029 Create a cache control breakpoint at this content block.
9491030
950 - `TextEditorCodeExecutionToolResultBlockParam object`
951
952 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
953
954 - `TextEditorCodeExecutionToolResultErrorParam object`
955
956 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
1031 - `ToolSearchToolResultBlockParam object`
1032
1033 - `type: "tool_search_tool_result"`
1034
1035 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1036
1037 - `ToolSearchToolResultErrorParam object`
1038
1039 - `type: "tool_search_tool_result_error"`
1040
1041 - `error_code: ToolSearchToolResultErrorCode`
9571042
9581043 - `"invalid_tool_input"`
9591044
from line 1048
9631048
9641049 - `"execution_time_exceeded"`
9651050
966 - `"file_not_found"`
967
968 - `type: "text_editor_code_execution_tool_result_error"`
969
9701051 - `error_message: optional string or null`
9711052
972 - `TextEditorCodeExecutionViewResultBlockParam object`
973
974 - `content: string`
975
976 - `file_type: "text" or "image" or "pdf"`
977
978 - `"text"`
979
980 - `"image"`
981
982 - `"pdf"`
983
984 - `type: "text_editor_code_execution_view_result"`
985
986 - `num_lines: optional number or null`
987
988 - `start_line: optional number or null`
989
990 - `total_lines: optional number or null`
991
992 - `TextEditorCodeExecutionCreateResultBlockParam object`
993
994 - `is_file_update: boolean`
995
996 - `type: "text_editor_code_execution_create_result"`
997
998 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
999
1000 - `type: "text_editor_code_execution_str_replace_result"`
1001
1002 - `lines: optional array of string or null`
1003
1004 - `new_lines: optional number or null`
1005
1006 - `new_start: optional number or null`
1007
1008 - `old_lines: optional number or null`
1009
1010 - `old_start: optional number or null`
1053 - `ToolSearchToolSearchResultBlockParam object`
1054
1055 - `type: "tool_search_tool_search_result"`
1056
1057 - `tool_references: array of ToolReferenceBlockParam`
1058
1059 - `type: "tool_reference"`
1060
1061 - `tool_name: string`
1062
1063 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1064
1065 - `cache_control: optional CacheControlEphemeral or null`
1066
1067 Create a cache control breakpoint at this content block.
10111068
10121069 - `tool_use_id: string`
10131070
10141071 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
1015
1016 - `type: "text_editor_code_execution_tool_result"`
1017
1018 - `cache_control: optional CacheControlEphemeral or null`
1019
1020 Create a cache control breakpoint at this content block.
1021
1022 - `ToolSearchToolResultBlockParam object`
1023
1024 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1025
1026 - `ToolSearchToolResultErrorParam object`
1027
1028 - `error_code: ToolSearchToolResultErrorCode`
1029
1030 - `"invalid_tool_input"`
1031
1032 - `"unavailable"`
1033
1034 - `"too_many_requests"`
1035
1036 - `"execution_time_exceeded"`
1037
1038 - `type: "tool_search_tool_result_error"`
1039
1040 - `error_message: optional string or null`
1041
1042 - `ToolSearchToolSearchResultBlockParam object`
1043
1044 - `tool_references: array of ToolReferenceBlockParam`
1045
1046 - `tool_name: string`
1047
1048 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1049
1050 - `type: "tool_reference"`
1051
1052 - `cache_control: optional CacheControlEphemeral or null`
1053
1054 Create a cache control breakpoint at this content block.
1055
1056 - `type: "tool_search_tool_search_result"`
1057
1058 - `tool_use_id: string`
1059
1060 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
1061
1062 - `type: "tool_search_tool_result"`
10631072
10641073 - `cache_control: optional CacheControlEphemeral or null`
10651074
from line 1079
10701079 A content block that represents a file to be uploaded to the container
10711080 Files uploaded via this block will be available in the container's input directory.
10721081
1082 - `type: "container_upload"`
1083
10731084 - `file_id: string`
10741085
1075 - `type: "container_upload"`
1076
10771086 - `cache_control: optional CacheControlEphemeral or null`
10781087
10791088 Create a cache control breakpoint at this content block.
from line 1199
11901199
11911200 maxItems: 20
11921201
1202 - `type: "anthropic" or "custom"`
1203
1204 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1205
1206 - `"anthropic"`
1207
1208 - `"custom"`
1209
11931210 - `skill_id: string`
11941211
11951212 Skill ID
11961213
11971214 maxLength: 64, minLength: 1
11981215
1199 - `type: "anthropic" or "custom"`
1200
1201 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1202
1203 - `"anthropic"`
1204
1205 - `"custom"`
1206
12071216 - `version: optional string`
12081217
12091218 Skill version or 'latest' for most recent version
from line 1259
12501259
12511260 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
12521261
1262 - `type: "json_schema"`
1263
12531264 - `schema: map[unknown]`
12541265
12551266 The JSON schema of the format
12561267
1257 - `type: "json_schema"`
1258
12591268 - `service_tier: optional "auto" or "standard_only"`
12601269
12611270 Determines whether to use priority capacity (if available) or standard capacity for this request.
from line 1299
12901299
12911300 - `array of TextBlockParam`
12921301
1302 - `type: "text"`
1303
12931304 - `text: string`
12941305
12951306 minLength: 1
12961307
1297 - `type: "text"`
1298
12991308 - `cache_control: optional CacheControlEphemeral or null`
13001309
13011310 Create a cache control breakpoint at this content block.
from line 1321
13121321
13131322 - `ThinkingConfigEnabled object`
13141323
1324 - `type: "enabled"`
1325
13151326 - `budget_tokens: number`
13161327
13171328 Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
from line 1333
13221333
13231334 minimum: 1024
13241335
1325 - `type: "enabled"`
1326
13271336 - `display: optional "summarized" or "omitted" or null`
13281337
13291338 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1389
13801389
13811390 The model will use the specified tool with `tool_choice.name`.
13821391
1392 - `type: "tool"`
1393
13831394 - `name: string`
13841395
13851396 The name of the tool to use.
1386
1387 - `type: "tool"`
13881397
13891398 - `disable_parallel_tool_use: optional boolean`
13901399
from line 1473
14641473
14651474 - `Tool object`
14661475
1476 - `type: optional "custom" or null`
1477
14671478 - `input_schema: object`
14681479
14691480 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
from line 1529
15181529
15191530 When true, guarantees schema validation on tool names and inputs
15201531
1521 - `type: optional "custom" or null`
1522
15231532 - `ToolBash20250124 object`
15241533
1534 - `type: "bash_20250124"`
1535
15251536 - `name: "bash"`
15261537
15271538 Name of the tool.
15281539
15291540 This is how the tool will be called by the model and in `tool_use` blocks.
15301541
1531 - `type: "bash_20250124"`
1532
15331542 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15341543
15351544 - `"direct"`
from line 1565
15561565
15571566 - `CodeExecutionTool20250522 object`
15581567
1568 - `type: "code_execution_20250522"`
1569
15591570 - `name: "code_execution"`
15601571
15611572 Name of the tool.
15621573
15631574 This is how the tool will be called by the model and in `tool_use` blocks.
15641575
1565 - `type: "code_execution_20250522"`
1566
15671576 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15681577
15691578 - `"direct"`
from line 1597
15881597
15891598 - `CodeExecutionTool20250825 object`
15901599
1600 - `type: "code_execution_20250825"`
1601
15911602 - `name: "code_execution"`
15921603
15931604 Name of the tool.
15941605
15951606 This is how the tool will be called by the model and in `tool_use` blocks.
15961607
1597 - `type: "code_execution_20250825"`
1598
15991608 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16001609
16011610 - `"direct"`
from line 1631
16221631
16231632 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
16241633
1634 - `type: "code_execution_20260120"`
1635
16251636 - `name: "code_execution"`
16261637
16271638 Name of the tool.
16281639
16291640 This is how the tool will be called by the model and in `tool_use` blocks.
16301641
1631 - `type: "code_execution_20260120"`
1632
16331642 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16341643
16351644 - `"direct"`
from line 1665
16561665
16571666 Code execution tool with REPL state persistence.
16581667
1668 - `type: "code_execution_20260521"`
1669
16591670 - `name: "code_execution"`
16601671
16611672 Name of the tool.
16621673
16631674 This is how the tool will be called by the model and in `tool_use` blocks.
1664
1665 - `type: "code_execution_20260521"`
16661675
16671676 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16681677
from line 1717
17081717 absent. Unknown keys are rejected: the field set is this toolset
17091718 version's complete member set.
17101719
1720 - `type: optional BrowserTypeConfig or null`
1721
1722 `type`'s config overrides.
1723
1724 - `defer_loading: optional boolean or null`
1725
1726 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1727
1728 - `enabled: optional boolean or null`
1729
1730 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
1731
17111732 - `close_tab: optional BrowserCloseTabConfig or null`
17121733
17131734 `close_tab`'s config overrides.
from line 2065
20442065
20452066 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
20462067
2047 - `type: optional BrowserTypeConfig or null`
2048
2049 `type`'s config overrides.
2068 - `wait: optional BrowserWaitConfig or null`
2069
2070 `wait`'s config overrides.
20502071
20512072 - `defer_loading: optional boolean or null`
20522073
from line 2077
20562077
20572078 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
20582079
2059 - `wait: optional BrowserWaitConfig or null`
2060
2061 `wait`'s config overrides.
2080 - `zoom: optional BrowserZoomConfig or null`
2081
2082 `zoom`'s config overrides.
20622083
20632084 - `defer_loading: optional boolean or null`
20642085
from line 2089
20682089
20692090 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
20702091
2071 - `zoom: optional BrowserZoomConfig or null`
2072
2073 `zoom`'s config overrides.
2074
2075 - `defer_loading: optional boolean or null`
2076
2077 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2078
2079 - `enabled: optional boolean or null`
2080
2081 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2082
20832092 - `MemoryTool20250818 object`
20842093
2094 - `type: "memory_20250818"`
2095
20852096 - `name: "memory"`
20862097
20872098 Name of the tool.
20882099
20892100 This is how the tool will be called by the model and in `tool_use` blocks.
2090
2091 - `type: "memory_20250818"`
20922101
20932102 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
20942103
from line 2149
21402149 absent. Unknown keys are rejected: the field set is this toolset
21412150 version's complete member set.
21422151
2152 - `type: optional ComputerTypeConfig or null`
2153
2154 `type`'s config overrides.
2155
2156 - `defer_loading: optional boolean or null`
2157
2158 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2159
2160 - `enabled: optional boolean or null`
2161
2162 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2163
21432164 - `cursor_position: optional ComputerCursorPositionConfig or null`
21442165
21452166 `cursor_position`'s config overrides.
from line 2329
23082329
23092330 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
23102331
2311 - `type: optional ComputerTypeConfig or null`
2312
2313 `type`'s config overrides.
2332 - `wait: optional ComputerWaitConfig or null`
2333
2334 `wait`'s config overrides.
23142335
23152336 - `defer_loading: optional boolean or null`
23162337
from line 2341
23202341
23212342 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
23222343
2323 - `wait: optional ComputerWaitConfig or null`
2324
2325 `wait`'s config overrides.
2344 - `zoom: optional ComputerZoomConfig or null`
2345
2346 `zoom`'s config overrides.
23262347
23272348 - `defer_loading: optional boolean or null`
23282349
from line 2353
23322353
23332354 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
23342355
2335 - `zoom: optional ComputerZoomConfig or null`
2336
2337 `zoom`'s config overrides.
2338
2339 - `defer_loading: optional boolean or null`
2340
2341 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2342
2343 - `enabled: optional boolean or null`
2344
2345 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2346
23472356 - `ToolTextEditor20250124 object`
23482357
2358 - `type: "text_editor_20250124"`
2359
23492360 - `name: "str_replace_editor"`
23502361
23512362 Name of the tool.
23522363
23532364 This is how the tool will be called by the model and in `tool_use` blocks.
23542365
2355 - `type: "text_editor_20250124"`
2356
23572366 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23582367
23592368 - `"direct"`
from line 2389
23802389
23812390 - `ToolTextEditor20250429 object`
23822391
2392 - `type: "text_editor_20250429"`
2393
23832394 - `name: "str_replace_based_edit_tool"`
23842395
23852396 Name of the tool.
23862397
23872398 This is how the tool will be called by the model and in `tool_use` blocks.
23882399
2389 - `type: "text_editor_20250429"`
2390
23912400 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23922401
23932402 - `"direct"`
from line 2423
24142423
24152424 - `ToolTextEditor20250728 object`
24162425
2426 - `type: "text_editor_20250728"`
2427
24172428 - `name: "str_replace_based_edit_tool"`
24182429
24192430 Name of the tool.
24202431
24212432 This is how the tool will be called by the model and in `tool_use` blocks.
24222433
2423 - `type: "text_editor_20250728"`
2424
24252434 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24262435
24272436 - `"direct"`
from line 2463
24542463
24552464 - `WebSearchTool20250305 object`
24562465
2466 - `type: "web_search_20250305"`
2467
24572468 - `name: "web_search"`
24582469
24592470 Name of the tool.
24602471
24612472 This is how the tool will be called by the model and in `tool_use` blocks.
24622473
2463 - `type: "web_search_20250305"`
2464
24652474 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24662475
24672476 - `"direct"`
from line 2539
25302539
25312540 - `WebFetchTool20250910 object`
25322541
2542 - `type: "web_fetch_20250910"`
2543
25332544 - `name: "web_fetch"`
25342545
25352546 Name of the tool.
25362547
25372548 This is how the tool will be called by the model and in `tool_use` blocks.
25382549
2539 - `type: "web_fetch_20250910"`
2540
25412550 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25422551
25432552 - `"direct"`
from line 2595
25862595
25872596 - `WebSearchTool20260209 object`
25882597
2598 - `type: "web_search_20260209"`
2599
25892600 - `name: "web_search"`
25902601
25912602 Name of the tool.
25922603
25932604 This is how the tool will be called by the model and in `tool_use` blocks.
25942605
2595 - `type: "web_search_20260209"`
2596
25972606 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25982607
25992608 - `"direct"`
from line 2645
26362645
26372646 - `WebFetchTool20260209 object`
26382647
2648 - `type: "web_fetch_20260209"`
2649
26392650 - `name: "web_fetch"`
26402651
26412652 Name of the tool.
26422653
26432654 This is how the tool will be called by the model and in `tool_use` blocks.
26442655
2645 - `type: "web_fetch_20260209"`
2646
26472656 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
26482657
26492658 - `"direct"`
from line 2703
26942703
26952704 Web fetch tool with use_cache parameter for bypassing cached content.
26962705
2706 - `type: "web_fetch_20260309"`
2707
26972708 - `name: "web_fetch"`
26982709
26992710 Name of the tool.
27002711
27012712 This is how the tool will be called by the model and in `tool_use` blocks.
27022713
2703 - `type: "web_fetch_20260309"`
2704
27052714 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27062715
27072716 - `"direct"`
from line 2763
27542763
27552764 - `WebSearchTool20260318 object`
27562765
2766 - `type: "web_search_20260318"`
2767
27572768 - `name: "web_search"`
27582769
27592770 Name of the tool.
27602771
27612772 This is how the tool will be called by the model and in `tool_use` blocks.
27622773
2763 - `type: "web_search_20260318"`
2764
27652774 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27662775
27672776 - `"direct"`
from line 2821
28122821
28132822 - `WebFetchTool20260318 object`
28142823
2824 - `type: "web_fetch_20260318"`
2825
28152826 - `name: "web_fetch"`
28162827
28172828 Name of the tool.
28182829
28192830 This is how the tool will be called by the model and in `tool_use` blocks.
28202831
2821 - `type: "web_fetch_20260318"`
2822
28232832 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28242833
28252834 - `"direct"`
from line 2889
28802889
28812890 - `ToolSearchToolBm25_20251119 object`
28822891
2892 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2893
2894 - `"tool_search_tool_bm25_20251119"`
2895
2896 - `"tool_search_tool_bm25"`
2897
28832898 - `name: "tool_search_tool_bm25"`
28842899
28852900 Name of the tool.
28862901
28872902 This is how the tool will be called by the model and in `tool_use` blocks.
28882903
2889 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2890
2891 - `"tool_search_tool_bm25_20251119"`
2892
2893 - `"tool_search_tool_bm25"`
2894
28952904 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28962905
28972906 - `"direct"`
from line 2925
29162925
29172926 - `ToolSearchToolRegex20251119 object`
29182927
2928 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2929
2930 - `"tool_search_tool_regex_20251119"`
2931
2932 - `"tool_search_tool_regex"`
2933
29192934 - `name: "tool_search_tool_regex"`
29202935
29212936 Name of the tool.
29222937
29232938 This is how the tool will be called by the model and in `tool_use` blocks.
29242939
2925 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2926
2927 - `"tool_search_tool_regex_20251119"`
2928
2929 - `"tool_search_tool_regex"`
2930
29312940 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
29322941
29332942 - `"direct"`
from line 2999
29902999
29913000- `MessageBatch object`
29923001
3002 - `type: "message_batch"`
3003
3004 Object type.
3005
3006 For Message Batches, this is always `"message_batch"`.
3007
3008 default: message_batch
3009
29933010 - `id: string`
29943011
29953012 Unique object identifier.
from line 3104
30873104 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
30883105
30893106 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
3090
3091 - `type: "message_batch"`
3092
3093 Object type.
3094
3095 For Message Batches, this is always `"message_batch"`.
3096
3097 default: message_batch
30983107
30993108### Example
31003109
from line 3168
31593168
31603169 ID of the Message Batch.
31613170
3171### Headers
3172
3173- `"anthropic-workspace-id": optional string`
3174
31623175### Returns
31633176
31643177- `MessageBatch object`
31653178
3179 - `type: "message_batch"`
3180
3181 Object type.
3182
3183 For Message Batches, this is always `"message_batch"`.
3184
3185 default: message_batch
3186
31663187 - `id: string`
31673188
31683189 Unique object identifier.
from line 3281
32603281 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
32613282
32623283 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
3263
3264 - `type: "message_batch"`
3265
3266 Object type.
3267
3268 For Message Batches, this is always `"message_batch"`.
3269
3270 default: message_batch
32713284
32723285### Example
32733286
from line 3339
33263339
33273340 default: 20, maximum: 1000, minimum: 1
33283341
3342### Headers
3343
3344- `"anthropic-workspace-id": optional string`
3345
33293346### Returns
33303347
33313348- `data: array of MessageBatch`
33323349
3350 - `type: "message_batch"`
3351
3352 Object type.
3353
3354 For Message Batches, this is always `"message_batch"`.
3355
3356 default: message_batch
3357
33333358 - `id: string`
33343359
33353360 Unique object identifier.
from line 3452
34273452 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
34283453
34293454 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
3430
3431 - `type: "message_batch"`
3432
3433 Object type.
3434
3435 For Message Batches, this is always `"message_batch"`.
3436
3437 default: message_batch
34383455
34393456- `first_id: string or null`
34403457
from line 3519
35023519
35033520 ID of the Message Batch.
35043521
3522### Headers
3523
3524- `"anthropic-workspace-id": optional string`
3525
35053526### Returns
35063527
35073528- `MessageBatch object`
35083529
3530 - `type: "message_batch"`
3531
3532 Object type.
3533
3534 For Message Batches, this is always `"message_batch"`.
3535
3536 default: message_batch
3537
35093538 - `id: string`
35103539
35113540 Unique object identifier.
from line 3632
36033632 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
36043633
36053634 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
3606
3607 - `type: "message_batch"`
3608
3609 Object type.
3610
3611 For Message Batches, this is always `"message_batch"`.
3612
3613 default: message_batch
36143635
36153636### Example
36163637
from line 3681
36603681
36613682 ID of the Message Batch.
36623683
3684### Headers
3685
3686- `"anthropic-workspace-id": optional string`
3687
36633688### Returns
36643689
36653690- `DeletedMessageBatch object`
36663691
3692 - `type: "message_batch_deleted"`
3693
3694 Deleted object type.
3695
3696 For Message Batches, this is always `"message_batch_deleted"`.
3697
3698 default: message_batch_deleted
3699
36673700 - `id: string`
36683701
36693702 ID of the Message Batch.
3670
3671 - `type: "message_batch_deleted"`
3672
3673 Deleted object type.
3674
3675 For Message Batches, this is always `"message_batch_deleted"`.
3676
3677 default: message_batch_deleted
36783703
36793704### Example
36803705
from line 3735
37103735
37113736 ID of the Message Batch.
37123737
3738### Headers
3739
3740- `"anthropic-workspace-id": optional string`
3741
37133742### Returns
37143743
37153744- `MessageBatchIndividualResponse object`
from line 3759
37303759
37313760 - `MessageBatchSucceededResult object`
37323761
3762 - `type: "succeeded"`
3763
3764 default: succeeded
3765
37333766 - `message: Message`
37343767
3768 - `type: "message"`
3769
3770 Object type.
3771
3772 For Messages, this is always `"message"`.
3773
3774 default: message
3775
37353776 - `id: string`
37363777
37373778 Unique object identifier.
from line 3797
37563797
37573798 Skills loaded in the container
37583799
3800 - `type: "anthropic" or "custom"`
3801
3802 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
3803
3804 - `"anthropic"`
3805
3806 - `"custom"`
3807
37593808 - `skill_id: string`
37603809
37613810 Skill ID
37623811
37633812 maxLength: 64, minLength: 1
3764
3765 - `type: "anthropic" or "custom"`
3766
3767 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
3768
3769 - `"anthropic"`
3770
3771 - `"custom"`
37723813
37733814 - `version: string`
37743815
from line 3848
38073848
38083849 - `TextBlock object`
38093850
3851 - `type: "text"`
3852
3853 default: text
3854
38103855 - `citations: array of TextCitation or null`
38113856
38123857 Citations supporting the text block.
from line 3860
38153860
38163861 - `CitationCharLocation object`
38173862
3863 - `type: "char_location"`
3864
3865 default: char_location
3866
38183867 - `cited_text: string`
38193868
38203869 - `document_index: number`
from line 3880
38313880
38323881 minimum: 0
38333882
3834 - `type: "char_location"`
3835
3836 default: char_location
3837
38383883 - `CitationPageLocation object`
38393884
3885 - `type: "page_location"`
3886
3887 default: page_location
3888
38403889 - `cited_text: string`
38413890
38423891 - `document_index: number`
from line 3902
38533902
38543903 minimum: 1
38553904
3856 - `type: "page_location"`
3857
3858 default: page_location
3859
38603905 - `CitationContentBlockLocation object`
38613906
3907 - `type: "content_block_location"`
3908
3909 default: content_block_location
3910
38623911 - `cited_text: string`
38633912
38643913 The full text of the cited block range, concatenated.
from line 3934
38853934
38863935 minimum: 0
38873936
3888 - `type: "content_block_location"`
3889
3890 default: content_block_location
3891
38923937 - `CitationsWebSearchResultLocation object`
38933938
3939 - `type: "web_search_result_location"`
3940
3941 default: web_search_result_location
3942
38943943 - `cited_text: string`
38953944
38963945 - `encrypted_index: string`
from line 3948
38993948
39003949 maxLength: 512
39013950
3902 - `type: "web_search_result_location"`
3903
3904 default: web_search_result_location
3905
39063951 - `url: string`
39073952
39083953 - `CitationsSearchResultLocation object`
39093954
3955 - `type: "search_result_location"`
3956
3957 default: search_result_location
3958
39103959 - `cited_text: string`
39113960
39123961 The full text of the cited block range, concatenated.
from line 3986
39373986
39383987 - `title: string or null`
39393988
3940 - `type: "search_result_location"`
3941
3942 default: search_result_location
3943
39443989 - `text: string`
39453990
3946 maxLength: 5000000, minLength: 0
3947
3948 - `type: "text"`
3949
3950 default: text
3991 minLength: 0
39513992
39523993 - `ThinkingBlock object`
39533994
3995 - `type: "thinking"`
3996
3997 default: thinking
3998
39543999 - `signature: string`
39554000
39564001 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 4008
39634008
39644009 The text of Claude's thinking process for this block.
39654010
3966 - `type: "thinking"`
3967
3968 default: thinking
3969
39704011 - `RedactedThinkingBlock object`
39714012
4013 - `type: "redacted_thinking"`
4014
4015 default: redacted_thinking
4016
39724017 - `data: string`
39734018
39744019 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 4022
39774022
39784023 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
39794024
3980 - `type: "redacted_thinking"`
3981
3982 default: redacted_thinking
3983
39844025 - `ToolUseBlock object`
39854026
4027 - `type: "tool_use"`
4028
4029 default: tool_use
4030
39864031 - `id: string`
39874032
39884033 pattern: ^[a-zA-Z0-9_-]+$
from line 4048
40034048
40044049 Tool invocation generated by a server-side tool.
40054050
4051 - `type: "code_execution_20250825"`
4052
40064053 - `tool_id: string`
40074054
40084055 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
40094056
4010 - `type: "code_execution_20250825"`
4011
40124057 - `ServerToolCaller20260120 object`
40134058
4059 - `type: "code_execution_20260120"`
4060
40144061 - `tool_id: string`
40154062
40164063 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
40174064
4018 - `type: "code_execution_20260120"`
4019
40204065 - `input: map[unknown]`
40214066
40224067 - `name: string`
40234068
40244069 minLength: 1
40254070
4026 - `type: "tool_use"`
4027
4028 default: tool_use
4029
40304071 - `toolset_name: optional string or null`
40314072
40324073 For a toolset member tool_use, the toolset family.
from line 4076
40354076
40364077 - `ServerToolUseBlock object`
40374078
4079 - `type: "server_tool_use"`
4080
4081 default: server_tool_use
4082
40384083 - `id: string`
40394084
40404085 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 4118
40734118
40744119 - `"tool_search_tool_bm25"`
40754120
4076 - `type: "server_tool_use"`
4077
4078 default: server_tool_use
4079
40804121 - `WebSearchToolResultBlock object`
40814122
4123 - `type: "web_search_tool_result"`
4124
4125 default: web_search_tool_result
4126
40824127 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
40834128
40844129 Tool invocation directly from the model.
from line 4144
40994144
41004145 - `WebSearchToolResultError object`
41014146
4147 - `type: "web_search_tool_result_error"`
4148
4149 default: web_search_tool_result_error
4150
41024151 - `error_code: WebSearchToolResultErrorCode`
41034152
41044153 - `"invalid_tool_input"`
from line 4162
41134162
41144163 - `"request_too_large"`
41154164
4116 - `type: "web_search_tool_result_error"`
4117
4118 default: web_search_tool_result_error
4119
41204165 - `array of WebSearchResultBlock`
41214166
4167 - `type: "web_search_result"`
4168
4169 default: web_search_result
4170
41224171 - `encrypted_content: string`
41234172
41244173 - `page_age: string or null`
41254174
41264175 - `title: string`
41274176
4128 - `type: "web_search_result"`
4129
4130 default: web_search_result
4131
41324177 - `url: string`
41334178
41344179 - `tool_use_id: string`
41354180
41364181 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
41374182
4138 - `type: "web_search_tool_result"`
4139
4140 default: web_search_tool_result
4141
41424183 - `WebFetchToolResultBlock object`
41434184
4185 - `type: "web_fetch_tool_result"`
4186
4187 default: web_fetch_tool_result
4188
41444189 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
41454190
41464191 Tool invocation directly from the model.
from line 4206
41614206
41624207 - `WebFetchToolResultErrorBlock object`
41634208
4209 - `type: "web_fetch_tool_result_error"`
4210
4211 default: web_fetch_tool_result_error
4212
41644213 - `error_code: WebFetchToolResultErrorCode`
41654214
41664215 - `"invalid_tool_input"`
from line 4230
41814230
41824231 - `"unavailable"`
41834232
4184 - `type: "web_fetch_tool_result_error"`
4185
4186 default: web_fetch_tool_result_error
4233 - `"content_too_large"`
41874234
41884235 - `WebFetchBlock object`
41894236
4237 - `type: "web_fetch_result"`
4238
4239 default: web_fetch_result
4240
41904241 - `content: DocumentBlock`
41914242
4243 - `type: "document"`
4244
4245 default: document
4246
41924247 - `citations: CitationsConfig or null`
41934248
41944249 Citation configuration for the document
from line 4256
42014256
42024257 - `Base64PDFSource object`
42034258
4259 - `type: "base64"`
4260
42044261 - `data: string`
42054262
42064263 format: byte
42074264
42084265 - `media_type: "application/pdf"`
42094266
4210 - `type: "base64"`
4211
42124267 - `PlainTextSource object`
42134268
4269 - `type: "text"`
4270
42144271 - `data: string`
42154272
42164273 - `media_type: "text/plain"`
42174274
4218 - `type: "text"`
4219
42204275 - `title: string or null`
42214276
42224277 The title of the document
42234278
4224 - `type: "document"`
4225
4226 default: document
4227
42284279 - `retrieved_at: string or null`
42294280
42304281 ISO 8601 timestamp when the content was retrieved
42314282
4232 - `type: "web_fetch_result"`
4233
4234 default: web_fetch_result
4235
42364283 - `url: string`
42374284
42384285 Fetched content URL
from line 4288
42414288
42424289 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
42434290
4244 - `type: "web_fetch_tool_result"`
4245
4246 default: web_fetch_tool_result
4247
42484291 - `CodeExecutionToolResultBlock object`
42494292
4293 - `type: "code_execution_tool_result"`
4294
4295 default: code_execution_tool_result
4296
42504297 - `content: CodeExecutionToolResultBlockContent`
42514298
42524299 Code execution result with encrypted stdout for PFC + web_search results.
42534300
42544301 - `CodeExecutionToolResultError object`
42554302
4303 - `type: "code_execution_tool_result_error"`
4304
4305 default: code_execution_tool_result_error
4306
42564307 - `error_code: CodeExecutionToolResultErrorCode`
42574308
42584309 - `"invalid_tool_input"`
from line 4314
42634314
42644315 - `"execution_time_exceeded"`
42654316
4266 - `type: "code_execution_tool_result_error"`
4267
4268 default: code_execution_tool_result_error
4269
42704317 - `CodeExecutionResultBlock object`
42714318
4319 - `type: "code_execution_result"`
4320
4321 default: code_execution_result
4322
42724323 - `content: array of CodeExecutionOutputBlock`
42734324
4325 - `type: "code_execution_output"`
4326
4327 default: code_execution_output
4328
42744329 - `file_id: string`
42754330
4331 - `return_code: number`
4332
4333 - `stderr: string`
4334
4335 - `stdout: string`
4336
4337 - `EncryptedCodeExecutionResultBlock object`
4338
4339 Code execution result with encrypted stdout for PFC + web_search results.
4340
4341 - `type: "encrypted_code_execution_result"`
4342
4343 default: encrypted_code_execution_result
4344
4345 - `content: array of CodeExecutionOutputBlock`
4346
42764347 - `type: "code_execution_output"`
42774348
42784349 default: code_execution_output
42794350
4351 - `file_id: string`
4352
4353 - `encrypted_stdout: string`
4354
42804355 - `return_code: number`
42814356
42824357 - `stderr: string`
42834358
4359 - `tool_use_id: string`
4360
4361 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
4362
4363 - `BashCodeExecutionToolResultBlock object`
4364
4365 - `type: "bash_code_execution_tool_result"`
4366
4367 default: bash_code_execution_tool_result
4368
4369 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
4370
4371 - `BashCodeExecutionToolResultError object`
4372
4373 - `type: "bash_code_execution_tool_result_error"`
4374
4375 default: bash_code_execution_tool_result_error
4376
4377 - `error_code: BashCodeExecutionToolResultErrorCode`
4378
4379 - `"invalid_tool_input"`
4380
4381 - `"unavailable"`
4382
4383 - `"too_many_requests"`
4384
4385 - `"execution_time_exceeded"`
4386
4387 - `"output_file_too_large"`
4388
4389 - `BashCodeExecutionResultBlock object`
4390
4391 - `type: "bash_code_execution_result"`
4392
4393 default: bash_code_execution_result
4394
4395 - `content: array of BashCodeExecutionOutputBlock`
4396
4397 - `type: "bash_code_execution_output"`
4398
4399 default: bash_code_execution_output
4400
4401 - `file_id: string`
4402
4403 - `return_code: number`
4404
4405 - `stderr: string`
4406
42844407 - `stdout: string`
42854408
4286 - `type: "code_execution_result"`
4287
4288 default: code_execution_result
4289
4290 - `EncryptedCodeExecutionResultBlock object`
4291
4292 Code execution result with encrypted stdout for PFC + web_search results.
4293
4294 - `content: array of CodeExecutionOutputBlock`
4295
4296 - `file_id: string`
4297
4298 - `type: "code_execution_output"`
4299
4300 default: code_execution_output
4301
4302 - `encrypted_stdout: string`
4303
4304 - `return_code: number`
4305
4306 - `stderr: string`
4307
4308 - `type: "encrypted_code_execution_result"`
4309
4310 default: encrypted_code_execution_result
4311
43124409 - `tool_use_id: string`
43134410
43144411 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
43154412
4316 - `type: "code_execution_tool_result"`
4317
4318 default: code_execution_tool_result
4319
4320 - `BashCodeExecutionToolResultBlock object`
4321
4322 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
4323
4324 - `BashCodeExecutionToolResultError object`
4325
4326 - `error_code: BashCodeExecutionToolResultErrorCode`
4413 - `TextEditorCodeExecutionToolResultBlock object`
4414
4415 - `type: "text_editor_code_execution_tool_result"`
4416
4417 default: text_editor_code_execution_tool_result
4418
4419 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
4420
4421 - `TextEditorCodeExecutionToolResultError object`
4422
4423 - `type: "text_editor_code_execution_tool_result_error"`
4424
4425 default: text_editor_code_execution_tool_result_error
4426
4427 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
43274428
43284429 - `"invalid_tool_input"`
43294430
from line 4434
43334434
43344435 - `"execution_time_exceeded"`
43354436
4336 - `"output_file_too_large"`
4337
4338 - `type: "bash_code_execution_tool_result_error"`
4339
4340 default: bash_code_execution_tool_result_error
4341
4342 - `BashCodeExecutionResultBlock object`
4343
4344 - `content: array of BashCodeExecutionOutputBlock`
4345
4346 - `file_id: string`
4347
4348 - `type: "bash_code_execution_output"`
4349
4350 default: bash_code_execution_output
4351
4352 - `return_code: number`
4353
4354 - `stderr: string`
4355
4356 - `stdout: string`
4357
4358 - `type: "bash_code_execution_result"`
4359
4360 default: bash_code_execution_result
4437 - `"file_not_found"`
4438
4439 - `error_message: string or null`
4440
4441 - `TextEditorCodeExecutionViewResultBlock object`
4442
4443 - `type: "text_editor_code_execution_view_result"`
4444
4445 default: text_editor_code_execution_view_result
4446
4447 - `content: string`
4448
4449 - `file_type: "text" or "image" or "pdf"`
4450
4451 - `"text"`
4452
4453 - `"image"`
4454
4455 - `"pdf"`
4456
4457 - `num_lines: number or null`
4458
4459 - `start_line: number or null`
4460
4461 - `total_lines: number or null`
4462
4463 - `TextEditorCodeExecutionCreateResultBlock object`
4464
4465 - `type: "text_editor_code_execution_create_result"`
4466
4467 default: text_editor_code_execution_create_result
4468
4469 - `is_file_update: boolean`
4470
4471 - `TextEditorCodeExecutionStrReplaceResultBlock object`
4472
4473 - `type: "text_editor_code_execution_str_replace_result"`
4474
4475 default: text_editor_code_execution_str_replace_result
4476
4477 - `lines: array of string or null`
4478
4479 - `new_lines: number or null`
4480
4481 - `new_start: number or null`
4482
4483 - `old_lines: number or null`
4484
4485 - `old_start: number or null`
43614486
43624487 - `tool_use_id: string`
43634488
43644489 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
43654490
4366 - `type: "bash_code_execution_tool_result"`
4367
4368 default: bash_code_execution_tool_result
4369
4370 - `TextEditorCodeExecutionToolResultBlock object`
4371
4372 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
4373
4374 - `TextEditorCodeExecutionToolResultError object`
4375
4376 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
4491 - `ToolSearchToolResultBlock object`
4492
4493 - `type: "tool_search_tool_result"`
4494
4495 default: tool_search_tool_result
4496
4497 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
4498
4499 - `ToolSearchToolResultError object`
4500
4501 - `type: "tool_search_tool_result_error"`
4502
4503 default: tool_search_tool_result_error
4504
4505 - `error_code: ToolSearchToolResultErrorCode`
43774506
43784507 - `"invalid_tool_input"`
43794508
from line 4512
43834512
43844513 - `"execution_time_exceeded"`
43854514
4386 - `"file_not_found"`
4387
43884515 - `error_message: string or null`
43894516
4390 - `type: "text_editor_code_execution_tool_result_error"`
4391
4392 default: text_editor_code_execution_tool_result_error
4393
4394 - `TextEditorCodeExecutionViewResultBlock object`
4395
4396 - `content: string`
4397
4398 - `file_type: "text" or "image" or "pdf"`
4399
4400 - `"text"`
4401
4402 - `"image"`
4403
4404 - `"pdf"`
4405
4406 - `num_lines: number or null`
4407
4408 - `start_line: number or null`
4409
4410 - `total_lines: number or null`
4411
4412 - `type: "text_editor_code_execution_view_result"`
4413
4414 default: text_editor_code_execution_view_result
4415
4416 - `TextEditorCodeExecutionCreateResultBlock object`
4417
4418 - `is_file_update: boolean`
4419
4420 - `type: "text_editor_code_execution_create_result"`
4421
4422 default: text_editor_code_execution_create_result
4423
4424 - `TextEditorCodeExecutionStrReplaceResultBlock object`
4425
4426 - `lines: array of string or null`
4427
4428 - `new_lines: number or null`
4429
4430 - `new_start: number or null`
4431
4432 - `old_lines: number or null`
4433
4434 - `old_start: number or null`
4435
4436 - `type: "text_editor_code_execution_str_replace_result"`
4437
4438 default: text_editor_code_execution_str_replace_result
4517 - `ToolSearchToolSearchResultBlock object`
4518
4519 - `type: "tool_search_tool_search_result"`
4520
4521 default: tool_search_tool_search_result
4522
4523 - `tool_references: array of ToolReferenceBlock`
4524
4525 - `type: "tool_reference"`
4526
4527 default: tool_reference
4528
4529 - `tool_name: string`
4530
4531 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
44394532
44404533 - `tool_use_id: string`
44414534
44424535 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
44434536
4444 - `type: "text_editor_code_execution_tool_result"`
4445
4446 default: text_editor_code_execution_tool_result
4447
4448 - `ToolSearchToolResultBlock object`
4449
4450 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
4451
4452 - `ToolSearchToolResultError object`
4453
4454 - `error_code: ToolSearchToolResultErrorCode`
4455
4456 - `"invalid_tool_input"`
4457
4458 - `"unavailable"`
4459
4460 - `"too_many_requests"`
4461
4462 - `"execution_time_exceeded"`
4463
4464 - `error_message: string or null`
4465
4466 - `type: "tool_search_tool_result_error"`
4467
4468 default: tool_search_tool_result_error
4469
4470 - `ToolSearchToolSearchResultBlock object`
4471
4472 - `tool_references: array of ToolReferenceBlock`
4473
4474 - `tool_name: string`
4475
4476 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
4477
4478 - `type: "tool_reference"`
4479
4480 default: tool_reference
4481
4482 - `type: "tool_search_tool_search_result"`
4483
4484 default: tool_search_tool_search_result
4485
4486 - `tool_use_id: string`
4487
4488 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
4489
4490 - `type: "tool_search_tool_result"`
4491
4492 default: tool_search_tool_result
4493
44944537 - `ContainerUploadBlock object`
44954538
44964539 Response model for a file uploaded to the container.
44974540
4541 - `type: "container_upload"`
4542
4543 default: container_upload
4544
44984545 - `file_id: string`
44994546
4500 - `type: "container_upload"`
4501
4502 default: container_upload
4503
45044547 - `model: Model`
45054548
45064549 The model that will complete your prompt.
from line 4638
45954638
45964639 Structured information about a refusal.
45974640
4641 - `type: "refusal"`
4642
4643 default: refusal
4644
45984645 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
45994646
46004647 The policy category that triggered a refusal.
from line 4671
46244671 Human-readable explanation of the refusal.
46254672
46264673 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
4627
4628 - `type: "refusal"`
4629
4630 default: refusal
46314674
46324675 - `stop_reason: StopReason or null`
46334676
from line 4708
46654708
46664709 This value will be a non-null string if one of your custom stop sequences was generated.
46674710
4668 - `type: "message"`
4669
4670 Object type.
4671
4672 For Messages, this is always `"message"`.
4673
4674 default: message
4675
46764711 - `usage: Usage`
46774712
46784713 Billing and rate-limit usage.
from line 4812
47774812
47784813 - `"batch"`
47794814
4780 - `type: "succeeded"`
4781
4782 default: succeeded
4783
47844815 - `MessageBatchErroredResult object`
47854816
4817 - `type: "errored"`
4818
4819 default: errored
4820
47864821 - `error: ErrorResponse`
47874822
4823 - `type: "error"`
4824
4825 default: error
4826
47884827 - `error: ErrorObject`
47894828
47904829 - `InvalidRequestError object`
47914830
4831 - `type: "invalid_request_error"`
4832
4833 default: invalid_request_error
4834
47924835 - `message: string`
47934836
47944837 default: Invalid request
47954838
4796 - `type: "invalid_request_error"`
4797
4798 default: invalid_request_error
4799
48004839 - `AuthenticationError object`
48014840
4841 - `type: "authentication_error"`
4842
4843 default: authentication_error
4844
48024845 - `message: string`
48034846
48044847 default: Authentication error
48054848
4806 - `type: "authentication_error"`
4807
4808 default: authentication_error
4809
48104849 - `BillingError object`
48114850
4851 - `type: "billing_error"`
4852
4853 default: billing_error
4854
48124855 - `message: string`
48134856
48144857 default: Billing error
48154858
4816 - `type: "billing_error"`
4817
4818 default: billing_error
4819
48204859 - `PermissionError object`
48214860
4861 - `type: "permission_error"`
4862
4863 default: permission_error
4864
48224865 - `message: string`
48234866
48244867 default: Permission denied
48254868
4826 - `type: "permission_error"`
4827
4828 default: permission_error
4829
48304869 - `NotFoundError object`
48314870
4871 - `type: "not_found_error"`
4872
4873 default: not_found_error
4874
48324875 - `message: string`
48334876
48344877 default: Not found
48354878
4836 - `type: "not_found_error"`
4837
4838 default: not_found_error
4839
48404879 - `RateLimitError object`
48414880
4881 - `type: "rate_limit_error"`
4882
4883 default: rate_limit_error
4884
48424885 - `message: string`
48434886
48444887 default: Rate limited
48454888
4846 - `type: "rate_limit_error"`
4847
4848 default: rate_limit_error
4849
48504889 - `GatewayTimeoutError object`
48514890
4891 - `type: "timeout_error"`
4892
4893 default: timeout_error
4894
48524895 - `message: string`
48534896
48544897 default: Request timeout
48554898
4856 - `type: "timeout_error"`
4857
4858 default: timeout_error
4859
48604899 - `APIErrorObject object`
48614900
4901 - `type: "api_error"`
4902
4903 default: api_error
4904
48624905 - `message: string`
48634906
48644907 default: Internal server error
48654908
4866 - `type: "api_error"`
4867
4868 default: api_error
4869
48704909 - `OverloadedError object`
48714910
4911 - `type: "overloaded_error"`
4912
4913 default: overloaded_error
4914
48724915 - `message: string`
48734916
48744917 default: Overloaded
48754918
4876 - `type: "overloaded_error"`
4877
4878 default: overloaded_error
4879
48804919 - `request_id: string or null`
4881
4882 - `type: "error"`
4883
4884 default: error
4885
4886 - `type: "errored"`
4887
4888 default: errored
48894920
48904921 - `MessageBatchCanceledResult object`
48914922
from line 4944
49134944
49144945- `DeletedMessageBatch object`
49154946
4947 - `type: "message_batch_deleted"`
4948
4949 Deleted object type.
4950
4951 For Message Batches, this is always `"message_batch_deleted"`.
4952
4953 default: message_batch_deleted
4954
49164955 - `id: string`
49174956
49184957 ID of the Message Batch.
49194958
4920 - `type: "message_batch_deleted"`
4921
4922 Deleted object type.
4923
4924 For Message Batches, this is always `"message_batch_deleted"`.
4925
4926 default: message_batch_deleted
4927
49284959### Message Batch
49294960
49304961- `MessageBatch object`
49314962
4963 - `type: "message_batch"`
4964
4965 Object type.
4966
4967 For Message Batches, this is always `"message_batch"`.
4968
4969 default: message_batch
4970
49324971 - `id: string`
49334972
49344973 Unique object identifier.
from line 5066
50275066
50285067 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
50295068
5030 - `type: "message_batch"`
5031
5032 Object type.
5033
5034 For Message Batches, this is always `"message_batch"`.
5035
5036 default: message_batch
5037
50385069### Message Batch Canceled Result
50395070
50405071- `MessageBatchCanceledResult object`
from line 5078
50475078
50485079- `MessageBatchErroredResult object`
50495080
5081 - `type: "errored"`
5082
5083 default: errored
5084
50505085 - `error: ErrorResponse`
50515086
5087 - `type: "error"`
5088
5089 default: error
5090
50525091 - `error: ErrorObject`
50535092
50545093 - `InvalidRequestError object`
50555094
5095 - `type: "invalid_request_error"`
5096
5097 default: invalid_request_error
5098
50565099 - `message: string`
50575100
50585101 default: Invalid request
50595102
5060 - `type: "invalid_request_error"`
5061
5062 default: invalid_request_error
5063
50645103 - `AuthenticationError object`
50655104
5105 - `type: "authentication_error"`
5106
5107 default: authentication_error
5108
50665109 - `message: string`
50675110
50685111 default: Authentication error
50695112
5070 - `type: "authentication_error"`
5071
5072 default: authentication_error
5073
50745113 - `BillingError object`
50755114
5115 - `type: "billing_error"`
5116
5117 default: billing_error
5118
50765119 - `message: string`
50775120
50785121 default: Billing error
50795122
5080 - `type: "billing_error"`
5081
5082 default: billing_error
5083
50845123 - `PermissionError object`
50855124
5125 - `type: "permission_error"`
5126
5127 default: permission_error
5128
50865129 - `message: string`
50875130
50885131 default: Permission denied
50895132
5090 - `type: "permission_error"`
5091
5092 default: permission_error
5093
50945133 - `NotFoundError object`
50955134
5135 - `type: "not_found_error"`
5136
5137 default: not_found_error
5138
50965139 - `message: string`
50975140
50985141 default: Not found
50995142
5100 - `type: "not_found_error"`
5101
5102 default: not_found_error
5103
51045143 - `RateLimitError object`
51055144
5145 - `type: "rate_limit_error"`
5146
5147 default: rate_limit_error
5148
51065149 - `message: string`
51075150
51085151 default: Rate limited
51095152
5110 - `type: "rate_limit_error"`
5111
5112 default: rate_limit_error
5113
51145153 - `GatewayTimeoutError object`
51155154
5155 - `type: "timeout_error"`
5156
5157 default: timeout_error
5158
51165159 - `message: string`
51175160
51185161 default: Request timeout
51195162
5120 - `type: "timeout_error"`
5121
5122 default: timeout_error
5123
51245163 - `APIErrorObject object`
51255164
5165 - `type: "api_error"`
5166
5167 default: api_error
5168
51265169 - `message: string`
51275170
51285171 default: Internal server error
51295172
5130 - `type: "api_error"`
5131
5132 default: api_error
5133
51345173 - `OverloadedError object`
51355174
5175 - `type: "overloaded_error"`
5176
5177 default: overloaded_error
5178
51365179 - `message: string`
51375180
51385181 default: Overloaded
51395182
5140 - `type: "overloaded_error"`
5141
5142 default: overloaded_error
5143
51445183 - `request_id: string or null`
51455184
5146 - `type: "error"`
5147
5148 default: error
5149
5150 - `type: "errored"`
5151
5152 default: errored
5153
51545185### Message Batch Expired Result
51555186
51565187- `MessageBatchExpiredResult object`
from line 5210
51795210
51805211 - `MessageBatchSucceededResult object`
51815212
5213 - `type: "succeeded"`
5214
5215 default: succeeded
5216
51825217 - `message: Message`
51835218
5219 - `type: "message"`
5220
5221 Object type.
5222
5223 For Messages, this is always `"message"`.
5224
5225 default: message
5226
51845227 - `id: string`
51855228
51865229 Unique object identifier.
from line 5248
52055248
52065249 Skills loaded in the container
52075250
5251 - `type: "anthropic" or "custom"`
5252
5253 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
5254
5255 - `"anthropic"`
5256
5257 - `"custom"`
5258
52085259 - `skill_id: string`
52095260
52105261 Skill ID
52115262
52125263 maxLength: 64, minLength: 1
5213
5214 - `type: "anthropic" or "custom"`
5215
5216 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
5217
5218 - `"anthropic"`
5219
5220 - `"custom"`
52215264
52225265 - `version: string`
52235266
from line 5299
52565299
52575300 - `TextBlock object`
52585301
5302 - `type: "text"`
5303
5304 default: text
5305
52595306 - `citations: array of TextCitation or null`
52605307
52615308 Citations supporting the text block.
from line 5311
52645311
52655312 - `CitationCharLocation object`
52665313
5314 - `type: "char_location"`
5315
5316 default: char_location
5317
52675318 - `cited_text: string`
52685319
52695320 - `document_index: number`
from line 5331
52805331
52815332 minimum: 0
52825333
5283 - `type: "char_location"`
5284
5285 default: char_location
5286
52875334 - `CitationPageLocation object`
52885335
5336 - `type: "page_location"`
5337
5338 default: page_location
5339
52895340 - `cited_text: string`
52905341
52915342 - `document_index: number`
from line 5353
53025353
53035354 minimum: 1
53045355
5305 - `type: "page_location"`
5306
5307 default: page_location
5308
53095356 - `CitationContentBlockLocation object`
53105357
5358 - `type: "content_block_location"`
5359
5360 default: content_block_location
5361
53115362 - `cited_text: string`
53125363
53135364 The full text of the cited block range, concatenated.
from line 5385
53345385
53355386 minimum: 0
53365387
5337 - `type: "content_block_location"`
5338
5339 default: content_block_location
5340
53415388 - `CitationsWebSearchResultLocation object`
53425389
5390 - `type: "web_search_result_location"`
5391
5392 default: web_search_result_location
5393
53435394 - `cited_text: string`
53445395
53455396 - `encrypted_index: string`
from line 5399
53485399
53495400 maxLength: 512
53505401
5351 - `type: "web_search_result_location"`
5352
5353 default: web_search_result_location
5354
53555402 - `url: string`
53565403
53575404 - `CitationsSearchResultLocation object`
53585405
5406 - `type: "search_result_location"`
5407
5408 default: search_result_location
5409
53595410 - `cited_text: string`
53605411
53615412 The full text of the cited block range, concatenated.
from line 5437
53865437
53875438 - `title: string or null`
53885439
5389 - `type: "search_result_location"`
5390
5391 default: search_result_location
5392
53935440 - `text: string`
53945441
5395 maxLength: 5000000, minLength: 0
5396
5397 - `type: "text"`
5398
5399 default: text
5442 minLength: 0
54005443
54015444 - `ThinkingBlock object`
54025445
5446 - `type: "thinking"`
5447
5448 default: thinking
5449
54035450 - `signature: string`
54045451
54055452 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 5459
54125459
54135460 The text of Claude's thinking process for this block.
54145461
5415 - `type: "thinking"`
5416
5417 default: thinking
5418
54195462 - `RedactedThinkingBlock object`
54205463
5464 - `type: "redacted_thinking"`
5465
5466 default: redacted_thinking
5467
54215468 - `data: string`
54225469
54235470 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 5473
54265473
54275474 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
54285475
5429 - `type: "redacted_thinking"`
5430
5431 default: redacted_thinking
5432
54335476 - `ToolUseBlock object`
54345477
5478 - `type: "tool_use"`
5479
5480 default: tool_use
5481
54355482 - `id: string`
54365483
54375484 pattern: ^[a-zA-Z0-9_-]+$
from line 5499
54525499
54535500 Tool invocation generated by a server-side tool.
54545501
5502 - `type: "code_execution_20250825"`
5503
54555504 - `tool_id: string`
54565505
54575506 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
54585507
5459 - `type: "code_execution_20250825"`
5460
54615508 - `ServerToolCaller20260120 object`
54625509
5510 - `type: "code_execution_20260120"`
5511
54635512 - `tool_id: string`
54645513
54655514 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
54665515
5467 - `type: "code_execution_20260120"`
5468
54695516 - `input: map[unknown]`
54705517
54715518 - `name: string`
54725519
54735520 minLength: 1
54745521
5475 - `type: "tool_use"`
5476
5477 default: tool_use
5478
54795522 - `toolset_name: optional string or null`
54805523
54815524 For a toolset member tool_use, the toolset family.
from line 5527
54845527
54855528 - `ServerToolUseBlock object`
54865529
5530 - `type: "server_tool_use"`
5531
5532 default: server_tool_use
5533
54875534 - `id: string`
54885535
54895536 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 5569
55225569
55235570 - `"tool_search_tool_bm25"`
55245571
5525 - `type: "server_tool_use"`
5526
5527 default: server_tool_use
5528
55295572 - `WebSearchToolResultBlock object`
55305573
5574 - `type: "web_search_tool_result"`
5575
5576 default: web_search_tool_result
5577
55315578 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
55325579
55335580 Tool invocation directly from the model.
from line 5595
55485595
55495596 - `WebSearchToolResultError object`
55505597
5598 - `type: "web_search_tool_result_error"`
5599
5600 default: web_search_tool_result_error
5601
55515602 - `error_code: WebSearchToolResultErrorCode`
55525603
55535604 - `"invalid_tool_input"`
from line 5613
55625613
55635614 - `"request_too_large"`
55645615
5565 - `type: "web_search_tool_result_error"`
5566
5567 default: web_search_tool_result_error
5568
55695616 - `array of WebSearchResultBlock`
55705617
5618 - `type: "web_search_result"`
5619
5620 default: web_search_result
5621
55715622 - `encrypted_content: string`
55725623
55735624 - `page_age: string or null`
55745625
55755626 - `title: string`
55765627
5577 - `type: "web_search_result"`
5578
5579 default: web_search_result
5580
55815628 - `url: string`
55825629
55835630 - `tool_use_id: string`
55845631
55855632 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
55865633
5587 - `type: "web_search_tool_result"`
5588
5589 default: web_search_tool_result
5590
55915634 - `WebFetchToolResultBlock object`
55925635
5636 - `type: "web_fetch_tool_result"`
5637
5638 default: web_fetch_tool_result
5639
55935640 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
55945641
55955642 Tool invocation directly from the model.
from line 5657
56105657
56115658 - `WebFetchToolResultErrorBlock object`
56125659
5660 - `type: "web_fetch_tool_result_error"`
5661
5662 default: web_fetch_tool_result_error
5663
56135664 - `error_code: WebFetchToolResultErrorCode`
56145665
56155666 - `"invalid_tool_input"`
from line 5681
56305681
56315682 - `"unavailable"`
56325683
5633 - `type: "web_fetch_tool_result_error"`
5634
5635 default: web_fetch_tool_result_error
5684 - `"content_too_large"`
56365685
56375686 - `WebFetchBlock object`
56385687
5688 - `type: "web_fetch_result"`
5689
5690 default: web_fetch_result
5691
56395692 - `content: DocumentBlock`
56405693
5694 - `type: "document"`
5695
5696 default: document
5697
56415698 - `citations: CitationsConfig or null`
56425699
56435700 Citation configuration for the document
from line 5707
56505707
56515708 - `Base64PDFSource object`
56525709
5710 - `type: "base64"`
5711
56535712 - `data: string`
56545713
56555714 format: byte
56565715
56575716 - `media_type: "application/pdf"`
56585717
5659 - `type: "base64"`
5660
56615718 - `PlainTextSource object`
56625719
5720 - `type: "text"`
5721
56635722 - `data: string`
56645723
56655724 - `media_type: "text/plain"`
56665725
5667 - `type: "text"`
5668
56695726 - `title: string or null`
56705727
56715728 The title of the document
56725729
5673 - `type: "document"`
5674
5675 default: document
5676
56775730 - `retrieved_at: string or null`
56785731
56795732 ISO 8601 timestamp when the content was retrieved
56805733
5681 - `type: "web_fetch_result"`
5682
5683 default: web_fetch_result
5684
56855734 - `url: string`
56865735
56875736 Fetched content URL
from line 5739
56905739
56915740 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
56925741
5693 - `type: "web_fetch_tool_result"`
5694
5695 default: web_fetch_tool_result
5696
56975742 - `CodeExecutionToolResultBlock object`
56985743
5744 - `type: "code_execution_tool_result"`
5745
5746 default: code_execution_tool_result
5747
56995748 - `content: CodeExecutionToolResultBlockContent`
57005749
57015750 Code execution result with encrypted stdout for PFC + web_search results.
57025751
57035752 - `CodeExecutionToolResultError object`
57045753
5754 - `type: "code_execution_tool_result_error"`
5755
5756 default: code_execution_tool_result_error
5757
57055758 - `error_code: CodeExecutionToolResultErrorCode`
57065759
57075760 - `"invalid_tool_input"`
from line 5765
57125765
57135766 - `"execution_time_exceeded"`
57145767
5715 - `type: "code_execution_tool_result_error"`
5716
5717 default: code_execution_tool_result_error
5718
57195768 - `CodeExecutionResultBlock object`
57205769
5770 - `type: "code_execution_result"`
5771
5772 default: code_execution_result
5773
57215774 - `content: array of CodeExecutionOutputBlock`
57225775
5776 - `type: "code_execution_output"`
5777
5778 default: code_execution_output
5779
57235780 - `file_id: string`
57245781
5782 - `return_code: number`
5783
5784 - `stderr: string`
5785
5786 - `stdout: string`
5787
5788 - `EncryptedCodeExecutionResultBlock object`
5789
5790 Code execution result with encrypted stdout for PFC + web_search results.
5791
5792 - `type: "encrypted_code_execution_result"`
5793
5794 default: encrypted_code_execution_result
5795
5796 - `content: array of CodeExecutionOutputBlock`
5797
57255798 - `type: "code_execution_output"`
57265799
57275800 default: code_execution_output
57285801
5802 - `file_id: string`
5803
5804 - `encrypted_stdout: string`
5805
57295806 - `return_code: number`
57305807
57315808 - `stderr: string`
57325809
5810 - `tool_use_id: string`
5811
5812 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
5813
5814 - `BashCodeExecutionToolResultBlock object`
5815
5816 - `type: "bash_code_execution_tool_result"`
5817
5818 default: bash_code_execution_tool_result
5819
5820 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
5821
5822 - `BashCodeExecutionToolResultError object`
5823
5824 - `type: "bash_code_execution_tool_result_error"`
5825
5826 default: bash_code_execution_tool_result_error
5827
5828 - `error_code: BashCodeExecutionToolResultErrorCode`
5829
5830 - `"invalid_tool_input"`
5831
5832 - `"unavailable"`
5833
5834 - `"too_many_requests"`
5835
5836 - `"execution_time_exceeded"`
5837
5838 - `"output_file_too_large"`
5839
5840 - `BashCodeExecutionResultBlock object`
5841
5842 - `type: "bash_code_execution_result"`
5843
5844 default: bash_code_execution_result
5845
5846 - `content: array of BashCodeExecutionOutputBlock`
5847
5848 - `type: "bash_code_execution_output"`
5849
5850 default: bash_code_execution_output
5851
5852 - `file_id: string`
5853
5854 - `return_code: number`
5855
5856 - `stderr: string`
5857
57335858 - `stdout: string`
57345859
5735 - `type: "code_execution_result"`
5736
5737 default: code_execution_result
5738
5739 - `EncryptedCodeExecutionResultBlock object`
5740
5741 Code execution result with encrypted stdout for PFC + web_search results.
5742
5743 - `content: array of CodeExecutionOutputBlock`
5744
5745 - `file_id: string`
5746
5747 - `type: "code_execution_output"`
5748
5749 default: code_execution_output
5750
5751 - `encrypted_stdout: string`
5752
5753 - `return_code: number`
5754
5755 - `stderr: string`
5756
5757 - `type: "encrypted_code_execution_result"`
5758
5759 default: encrypted_code_execution_result
5760
57615860 - `tool_use_id: string`
57625861
57635862 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
57645863
5765 - `type: "code_execution_tool_result"`
5766
5767 default: code_execution_tool_result
5768
5769 - `BashCodeExecutionToolResultBlock object`
5770
5771 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
5772
5773 - `BashCodeExecutionToolResultError object`
5774
5775 - `error_code: BashCodeExecutionToolResultErrorCode`
5864 - `TextEditorCodeExecutionToolResultBlock object`
5865
5866 - `type: "text_editor_code_execution_tool_result"`
5867
5868 default: text_editor_code_execution_tool_result
5869
5870 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
5871
5872 - `TextEditorCodeExecutionToolResultError object`
5873
5874 - `type: "text_editor_code_execution_tool_result_error"`
5875
5876 default: text_editor_code_execution_tool_result_error
5877
5878 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
57765879
57775880 - `"invalid_tool_input"`
57785881
from line 5885
57825885
57835886 - `"execution_time_exceeded"`
57845887
5785 - `"output_file_too_large"`
5786
5787 - `type: "bash_code_execution_tool_result_error"`
5788
5789 default: bash_code_execution_tool_result_error
5790
5791 - `BashCodeExecutionResultBlock object`
5792
5793 - `content: array of BashCodeExecutionOutputBlock`
5794
5795 - `file_id: string`
5796
5797 - `type: "bash_code_execution_output"`
5798
5799 default: bash_code_execution_output
5800
5801 - `return_code: number`
5802
5803 - `stderr: string`
5804
5805 - `stdout: string`
5806
5807 - `type: "bash_code_execution_result"`
5808
5809 default: bash_code_execution_result
5888 - `"file_not_found"`
5889
5890 - `error_message: string or null`
5891
5892 - `TextEditorCodeExecutionViewResultBlock object`
5893
5894 - `type: "text_editor_code_execution_view_result"`
5895
5896 default: text_editor_code_execution_view_result
5897
5898 - `content: string`
5899
5900 - `file_type: "text" or "image" or "pdf"`
5901
5902 - `"text"`
5903
5904 - `"image"`
5905
5906 - `"pdf"`
5907
5908 - `num_lines: number or null`
5909
5910 - `start_line: number or null`
5911
5912 - `total_lines: number or null`
5913
5914 - `TextEditorCodeExecutionCreateResultBlock object`
5915
5916 - `type: "text_editor_code_execution_create_result"`
5917
5918 default: text_editor_code_execution_create_result
5919
5920 - `is_file_update: boolean`
5921
5922 - `TextEditorCodeExecutionStrReplaceResultBlock object`
5923
5924 - `type: "text_editor_code_execution_str_replace_result"`
5925
5926 default: text_editor_code_execution_str_replace_result
5927
5928 - `lines: array of string or null`
5929
5930 - `new_lines: number or null`
5931
5932 - `new_start: number or null`
5933
5934 - `old_lines: number or null`
5935
5936 - `old_start: number or null`
58105937
58115938 - `tool_use_id: string`
58125939
58135940 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
58145941
5815 - `type: "bash_code_execution_tool_result"`
5816
5817 default: bash_code_execution_tool_result
5818
5819 - `TextEditorCodeExecutionToolResultBlock object`
5820
5821 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
5822
5823 - `TextEditorCodeExecutionToolResultError object`
5824
5825 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
5942 - `ToolSearchToolResultBlock object`
5943
5944 - `type: "tool_search_tool_result"`
5945
5946 default: tool_search_tool_result
5947
5948 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
5949
5950 - `ToolSearchToolResultError object`
5951
5952 - `type: "tool_search_tool_result_error"`
5953
5954 default: tool_search_tool_result_error
5955
5956 - `error_code: ToolSearchToolResultErrorCode`
58265957
58275958 - `"invalid_tool_input"`
58285959
from line 5963
58325963
58335964 - `"execution_time_exceeded"`
58345965
5835 - `"file_not_found"`
5836
58375966 - `error_message: string or null`
58385967
5839 - `type: "text_editor_code_execution_tool_result_error"`
5840
5841 default: text_editor_code_execution_tool_result_error
5842
5843 - `TextEditorCodeExecutionViewResultBlock object`
5844
5845 - `content: string`
5846
5847 - `file_type: "text" or "image" or "pdf"`
5848
5849 - `"text"`
5850
5851 - `"image"`
5852
5853 - `"pdf"`
5854
5855 - `num_lines: number or null`
5856
5857 - `start_line: number or null`
5858
5859 - `total_lines: number or null`
5860
5861 - `type: "text_editor_code_execution_view_result"`
5862
5863 default: text_editor_code_execution_view_result
5864
5865 - `TextEditorCodeExecutionCreateResultBlock object`
5866
5867 - `is_file_update: boolean`
5868
5869 - `type: "text_editor_code_execution_create_result"`
5870
5871 default: text_editor_code_execution_create_result
5872
5873 - `TextEditorCodeExecutionStrReplaceResultBlock object`
5874
5875 - `lines: array of string or null`
5876
5877 - `new_lines: number or null`
5878
5879 - `new_start: number or null`
5880
5881 - `old_lines: number or null`
5882
5883 - `old_start: number or null`
5884
5885 - `type: "text_editor_code_execution_str_replace_result"`
5886
5887 default: text_editor_code_execution_str_replace_result
5968 - `ToolSearchToolSearchResultBlock object`
5969
5970 - `type: "tool_search_tool_search_result"`
5971
5972 default: tool_search_tool_search_result
5973
5974 - `tool_references: array of ToolReferenceBlock`
5975
5976 - `type: "tool_reference"`
5977
5978 default: tool_reference
5979
5980 - `tool_name: string`
5981
5982 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
58885983
58895984 - `tool_use_id: string`
58905985
58915986 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
58925987
5893 - `type: "text_editor_code_execution_tool_result"`
5894
5895 default: text_editor_code_execution_tool_result
5896
5897 - `ToolSearchToolResultBlock object`
5898
5899 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
5900
5901 - `ToolSearchToolResultError object`
5902
5903 - `error_code: ToolSearchToolResultErrorCode`
5904
5905 - `"invalid_tool_input"`
5906
5907 - `"unavailable"`
5908
5909 - `"too_many_requests"`
5910
5911 - `"execution_time_exceeded"`
5912
5913 - `error_message: string or null`
5914
5915 - `type: "tool_search_tool_result_error"`
5916
5917 default: tool_search_tool_result_error
5918
5919 - `ToolSearchToolSearchResultBlock object`
5920
5921 - `tool_references: array of ToolReferenceBlock`
5922
5923 - `tool_name: string`
5924
5925 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
5926
5927 - `type: "tool_reference"`
5928
5929 default: tool_reference
5930
5931 - `type: "tool_search_tool_search_result"`
5932
5933 default: tool_search_tool_search_result
5934
5935 - `tool_use_id: string`
5936
5937 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
5938
5939 - `type: "tool_search_tool_result"`
5940
5941 default: tool_search_tool_result
5942
59435988 - `ContainerUploadBlock object`
59445989
59455990 Response model for a file uploaded to the container.
59465991
5992 - `type: "container_upload"`
5993
5994 default: container_upload
5995
59475996 - `file_id: string`
59485997
5949 - `type: "container_upload"`
5950
5951 default: container_upload
5952
59535998 - `model: Model`
59545999
59556000 The model that will complete your prompt.
from line 6089
60446089
60456090 Structured information about a refusal.
60466091
6092 - `type: "refusal"`
6093
6094 default: refusal
6095
60476096 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
60486097
60496098 The policy category that triggered a refusal.
from line 6122
60736122 Human-readable explanation of the refusal.
60746123
60756124 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
6076
6077 - `type: "refusal"`
6078
6079 default: refusal
60806125
60816126 - `stop_reason: StopReason or null`
60826127
from line 6159
61146159
61156160 This value will be a non-null string if one of your custom stop sequences was generated.
61166161
6117 - `type: "message"`
6118
6119 Object type.
6120
6121 For Messages, this is always `"message"`.
6122
6123 default: message
6124
61256162 - `usage: Usage`
61266163
61276164 Billing and rate-limit usage.
from line 6263
62266263
62276264 - `"batch"`
62286265
6229 - `type: "succeeded"`
6230
6231 default: succeeded
6232
62336266 - `MessageBatchErroredResult object`
62346267
6268 - `type: "errored"`
6269
6270 default: errored
6271
62356272 - `error: ErrorResponse`
62366273
6274 - `type: "error"`
6275
6276 default: error
6277
62376278 - `error: ErrorObject`
62386279
62396280 - `InvalidRequestError object`
62406281
6282 - `type: "invalid_request_error"`
6283
6284 default: invalid_request_error
6285
62416286 - `message: string`
62426287
62436288 default: Invalid request
62446289
6245 - `type: "invalid_request_error"`
6246
6247 default: invalid_request_error
6248
62496290 - `AuthenticationError object`
62506291
6292 - `type: "authentication_error"`
6293
6294 default: authentication_error
6295
62516296 - `message: string`
62526297
62536298 default: Authentication error
62546299
6255 - `type: "authentication_error"`
6256
6257 default: authentication_error
6258
62596300 - `BillingError object`
62606301
6302 - `type: "billing_error"`
6303
6304 default: billing_error
6305
62616306 - `message: string`
62626307
62636308 default: Billing error
62646309
6265 - `type: "billing_error"`
6266
6267 default: billing_error
6268
62696310 - `PermissionError object`
62706311
6312 - `type: "permission_error"`
6313
6314 default: permission_error
6315
62716316 - `message: string`
62726317
62736318 default: Permission denied
62746319
6275 - `type: "permission_error"`
6276
6277 default: permission_error
6278
62796320 - `NotFoundError object`
62806321
6322 - `type: "not_found_error"`
6323
6324 default: not_found_error
6325
62816326 - `message: string`
62826327
62836328 default: Not found
62846329
6285 - `type: "not_found_error"`
6286
6287 default: not_found_error
6288
62896330 - `RateLimitError object`
62906331
6332 - `type: "rate_limit_error"`
6333
6334 default: rate_limit_error
6335
62916336 - `message: string`
62926337
62936338 default: Rate limited
62946339
6295 - `type: "rate_limit_error"`
6296
6297 default: rate_limit_error
6298
62996340 - `GatewayTimeoutError object`
63006341
6342 - `type: "timeout_error"`
6343
6344 default: timeout_error
6345
63016346 - `message: string`
63026347
63036348 default: Request timeout
63046349
6305 - `type: "timeout_error"`
6306
6307 default: timeout_error
6308
63096350 - `APIErrorObject object`
63106351
6352 - `type: "api_error"`
6353
6354 default: api_error
6355
63116356 - `message: string`
63126357
63136358 default: Internal server error
63146359
6315 - `type: "api_error"`
6316
6317 default: api_error
6318
63196360 - `OverloadedError object`
63206361
6362 - `type: "overloaded_error"`
6363
6364 default: overloaded_error
6365
63216366 - `message: string`
63226367
63236368 default: Overloaded
63246369
6325 - `type: "overloaded_error"`
6326
6327 default: overloaded_error
6328
63296370 - `request_id: string or null`
63306371
6331 - `type: "error"`
6332
6333 default: error
6334
6335 - `type: "errored"`
6336
6337 default: errored
6338
63396372 - `MessageBatchCanceledResult object`
63406373
63416374 - `type: "canceled"`
from line 6433
64006433
64016434 - `MessageBatchSucceededResult object`
64026435
6436 - `type: "succeeded"`
6437
6438 default: succeeded
6439
64036440 - `message: Message`
64046441
6442 - `type: "message"`
6443
6444 Object type.
6445
6446 For Messages, this is always `"message"`.
6447
6448 default: message
6449
64056450 - `id: string`
64066451
64076452 Unique object identifier.
from line 6471
64266471
64276472 Skills loaded in the container
64286473
6474 - `type: "anthropic" or "custom"`
6475
6476 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
6477
6478 - `"anthropic"`
6479
6480 - `"custom"`
6481
64296482 - `skill_id: string`
64306483
64316484 Skill ID
64326485
64336486 maxLength: 64, minLength: 1
6434
6435 - `type: "anthropic" or "custom"`
6436
6437 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
6438
6439 - `"anthropic"`
6440
6441 - `"custom"`
64426487
64436488 - `version: string`
64446489
from line 6522
64776522
64786523 - `TextBlock object`
64796524
6525 - `type: "text"`
6526
6527 default: text
6528
64806529 - `citations: array of TextCitation or null`
64816530
64826531 Citations supporting the text block.
from line 6534
64856534
64866535 - `CitationCharLocation object`
64876536
6537 - `type: "char_location"`
6538
6539 default: char_location
6540
64886541 - `cited_text: string`
64896542
64906543 - `document_index: number`
from line 6554
65016554
65026555 minimum: 0
65036556
6504 - `type: "char_location"`
6505
6506 default: char_location
6507
65086557 - `CitationPageLocation object`
65096558
6559 - `type: "page_location"`
6560
6561 default: page_location
6562
65106563 - `cited_text: string`
65116564
65126565 - `document_index: number`
from line 6576
65236576
65246577 minimum: 1
65256578
6526 - `type: "page_location"`
6527
6528 default: page_location
6529
65306579 - `CitationContentBlockLocation object`
65316580
6581 - `type: "content_block_location"`
6582
6583 default: content_block_location
6584
65326585 - `cited_text: string`
65336586
65346587 The full text of the cited block range, concatenated.
from line 6608
65556608
65566609 minimum: 0
65576610
6558 - `type: "content_block_location"`
6559
6560 default: content_block_location
6561
65626611 - `CitationsWebSearchResultLocation object`
65636612
6613 - `type: "web_search_result_location"`
6614
6615 default: web_search_result_location
6616
65646617 - `cited_text: string`
65656618
65666619 - `encrypted_index: string`
from line 6622
65696622
65706623 maxLength: 512
65716624
6572 - `type: "web_search_result_location"`
6573
6574 default: web_search_result_location
6575
65766625 - `url: string`
65776626
65786627 - `CitationsSearchResultLocation object`
65796628
6629 - `type: "search_result_location"`
6630
6631 default: search_result_location
6632
65806633 - `cited_text: string`
65816634
65826635 The full text of the cited block range, concatenated.
from line 6660
66076660
66086661 - `title: string or null`
66096662
6610 - `type: "search_result_location"`
6611
6612 default: search_result_location
6613
66146663 - `text: string`
66156664
6616 maxLength: 5000000, minLength: 0
6617
6618 - `type: "text"`
6619
6620 default: text
6665 minLength: 0
66216666
66226667 - `ThinkingBlock object`
66236668
6669 - `type: "thinking"`
6670
6671 default: thinking
6672
66246673 - `signature: string`
66256674
66266675 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 6682
66336682
66346683 The text of Claude's thinking process for this block.
66356684
6636 - `type: "thinking"`
6637
6638 default: thinking
6639
66406685 - `RedactedThinkingBlock object`
66416686
6687 - `type: "redacted_thinking"`
6688
6689 default: redacted_thinking
6690
66426691 - `data: string`
66436692
66446693 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 6696
66476696
66486697 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
66496698
6650 - `type: "redacted_thinking"`
6651
6652 default: redacted_thinking
6653
66546699 - `ToolUseBlock object`
66556700
6701 - `type: "tool_use"`
6702
6703 default: tool_use
6704
66566705 - `id: string`
66576706
66586707 pattern: ^[a-zA-Z0-9_-]+$
from line 6722
66736722
66746723 Tool invocation generated by a server-side tool.
66756724
6725 - `type: "code_execution_20250825"`
6726
66766727 - `tool_id: string`
66776728
66786729 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
66796730
6680 - `type: "code_execution_20250825"`
6681
66826731 - `ServerToolCaller20260120 object`
66836732
6733 - `type: "code_execution_20260120"`
6734
66846735 - `tool_id: string`
66856736
66866737 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
66876738
6688 - `type: "code_execution_20260120"`
6689
66906739 - `input: map[unknown]`
66916740
66926741 - `name: string`
66936742
66946743 minLength: 1
66956744
6696 - `type: "tool_use"`
6697
6698 default: tool_use
6699
67006745 - `toolset_name: optional string or null`
67016746
67026747 For a toolset member tool_use, the toolset family.
from line 6750
67056750
67066751 - `ServerToolUseBlock object`
67076752
6753 - `type: "server_tool_use"`
6754
6755 default: server_tool_use
6756
67086757 - `id: string`
67096758
67106759 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 6792
67436792
67446793 - `"tool_search_tool_bm25"`
67456794
6746 - `type: "server_tool_use"`
6747
6748 default: server_tool_use
6749
67506795 - `WebSearchToolResultBlock object`
67516796
6797 - `type: "web_search_tool_result"`
6798
6799 default: web_search_tool_result
6800
67526801 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
67536802
67546803 Tool invocation directly from the model.
from line 6818
67696818
67706819 - `WebSearchToolResultError object`
67716820
6821 - `type: "web_search_tool_result_error"`
6822
6823 default: web_search_tool_result_error
6824
67726825 - `error_code: WebSearchToolResultErrorCode`
67736826
67746827 - `"invalid_tool_input"`
from line 6836
67836836
67846837 - `"request_too_large"`
67856838
6786 - `type: "web_search_tool_result_error"`
6787
6788 default: web_search_tool_result_error
6789
67906839 - `array of WebSearchResultBlock`
67916840
6841 - `type: "web_search_result"`
6842
6843 default: web_search_result
6844
67926845 - `encrypted_content: string`
67936846
67946847 - `page_age: string or null`
67956848
67966849 - `title: string`
67976850
6798 - `type: "web_search_result"`
6799
6800 default: web_search_result
6801
68026851 - `url: string`
68036852
68046853 - `tool_use_id: string`
68056854
68066855 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
68076856
6808 - `type: "web_search_tool_result"`
6809
6810 default: web_search_tool_result
6811
68126857 - `WebFetchToolResultBlock object`
68136858
6859 - `type: "web_fetch_tool_result"`
6860
6861 default: web_fetch_tool_result
6862
68146863 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
68156864
68166865 Tool invocation directly from the model.
from line 6880
68316880
68326881 - `WebFetchToolResultErrorBlock object`
68336882
6883 - `type: "web_fetch_tool_result_error"`
6884
6885 default: web_fetch_tool_result_error
6886
68346887 - `error_code: WebFetchToolResultErrorCode`
68356888
68366889 - `"invalid_tool_input"`
from line 6904
68516904
68526905 - `"unavailable"`
68536906
6854 - `type: "web_fetch_tool_result_error"`
6855
6856 default: web_fetch_tool_result_error
6907 - `"content_too_large"`
68576908
68586909 - `WebFetchBlock object`
68596910
6911 - `type: "web_fetch_result"`
6912
6913 default: web_fetch_result
6914
68606915 - `content: DocumentBlock`
68616916
6917 - `type: "document"`
6918
6919 default: document
6920
68626921 - `citations: CitationsConfig or null`
68636922
68646923 Citation configuration for the document
from line 6930
68716930
68726931 - `Base64PDFSource object`
68736932
6933 - `type: "base64"`
6934
68746935 - `data: string`
68756936
68766937 format: byte
68776938
68786939 - `media_type: "application/pdf"`
68796940
6880 - `type: "base64"`
6881
68826941 - `PlainTextSource object`
68836942
6943 - `type: "text"`
6944
68846945 - `data: string`
68856946
68866947 - `media_type: "text/plain"`
68876948
6888 - `type: "text"`
6889
68906949 - `title: string or null`
68916950
68926951 The title of the document
68936952
6894 - `type: "document"`
6895
6896 default: document
6897
68986953 - `retrieved_at: string or null`
68996954
69006955 ISO 8601 timestamp when the content was retrieved
69016956
6902 - `type: "web_fetch_result"`
6903
6904 default: web_fetch_result
6905
69066957 - `url: string`
69076958
69086959 Fetched content URL
from line 6962
69116962
69126963 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
69136964
6914 - `type: "web_fetch_tool_result"`
6915
6916 default: web_fetch_tool_result
6917
69186965 - `CodeExecutionToolResultBlock object`
69196966
6967 - `type: "code_execution_tool_result"`
6968
6969 default: code_execution_tool_result
6970
69206971 - `content: CodeExecutionToolResultBlockContent`
69216972
69226973 Code execution result with encrypted stdout for PFC + web_search results.
69236974
69246975 - `CodeExecutionToolResultError object`
69256976
6977 - `type: "code_execution_tool_result_error"`
6978
6979 default: code_execution_tool_result_error
6980
69266981 - `error_code: CodeExecutionToolResultErrorCode`
69276982
69286983 - `"invalid_tool_input"`
from line 6988
69336988
69346989 - `"execution_time_exceeded"`
69356990
6936 - `type: "code_execution_tool_result_error"`
6937
6938 default: code_execution_tool_result_error
6939
69406991 - `CodeExecutionResultBlock object`
69416992
6993 - `type: "code_execution_result"`
6994
6995 default: code_execution_result
6996
69426997 - `content: array of CodeExecutionOutputBlock`
69436998
6999 - `type: "code_execution_output"`
7000
7001 default: code_execution_output
7002
69447003 - `file_id: string`
69457004
7005 - `return_code: number`
7006
7007 - `stderr: string`
7008
7009 - `stdout: string`
7010
7011 - `EncryptedCodeExecutionResultBlock object`
7012
7013 Code execution result with encrypted stdout for PFC + web_search results.
7014
7015 - `type: "encrypted_code_execution_result"`
7016
7017 default: encrypted_code_execution_result
7018
7019 - `content: array of CodeExecutionOutputBlock`
7020
69467021 - `type: "code_execution_output"`
69477022
69487023 default: code_execution_output
69497024
7025 - `file_id: string`
7026
7027 - `encrypted_stdout: string`
7028
69507029 - `return_code: number`
69517030
69527031 - `stderr: string`
69537032
7033 - `tool_use_id: string`
7034
7035 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
7036
7037 - `BashCodeExecutionToolResultBlock object`
7038
7039 - `type: "bash_code_execution_tool_result"`
7040
7041 default: bash_code_execution_tool_result
7042
7043 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
7044
7045 - `BashCodeExecutionToolResultError object`
7046
7047 - `type: "bash_code_execution_tool_result_error"`
7048
7049 default: bash_code_execution_tool_result_error
7050
7051 - `error_code: BashCodeExecutionToolResultErrorCode`
7052
7053 - `"invalid_tool_input"`
7054
7055 - `"unavailable"`
7056
7057 - `"too_many_requests"`
7058
7059 - `"execution_time_exceeded"`
7060
7061 - `"output_file_too_large"`
7062
7063 - `BashCodeExecutionResultBlock object`
7064
7065 - `type: "bash_code_execution_result"`
7066
7067 default: bash_code_execution_result
7068
7069 - `content: array of BashCodeExecutionOutputBlock`
7070
7071 - `type: "bash_code_execution_output"`
7072
7073 default: bash_code_execution_output
7074
7075 - `file_id: string`
7076
7077 - `return_code: number`
7078
7079 - `stderr: string`
7080
69547081 - `stdout: string`
69557082
6956 - `type: "code_execution_result"`
6957
6958 default: code_execution_result
6959
6960 - `EncryptedCodeExecutionResultBlock object`
6961
6962 Code execution result with encrypted stdout for PFC + web_search results.
6963
6964 - `content: array of CodeExecutionOutputBlock`
6965
6966 - `file_id: string`
6967
6968 - `type: "code_execution_output"`
6969
6970 default: code_execution_output
6971
6972 - `encrypted_stdout: string`
6973
6974 - `return_code: number`
6975
6976 - `stderr: string`
6977
6978 - `type: "encrypted_code_execution_result"`
6979
6980 default: encrypted_code_execution_result
6981
69827083 - `tool_use_id: string`
69837084
69847085 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
69857086
6986 - `type: "code_execution_tool_result"`
6987
6988 default: code_execution_tool_result
6989
6990 - `BashCodeExecutionToolResultBlock object`
6991
6992 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
6993
6994 - `BashCodeExecutionToolResultError object`
6995
6996 - `error_code: BashCodeExecutionToolResultErrorCode`
7087 - `TextEditorCodeExecutionToolResultBlock object`
7088
7089 - `type: "text_editor_code_execution_tool_result"`
7090
7091 default: text_editor_code_execution_tool_result
7092
7093 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
7094
7095 - `TextEditorCodeExecutionToolResultError object`
7096
7097 - `type: "text_editor_code_execution_tool_result_error"`
7098
7099 default: text_editor_code_execution_tool_result_error
7100
7101 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
69977102
69987103 - `"invalid_tool_input"`
69997104
from line 7108
70037108
70047109 - `"execution_time_exceeded"`
70057110
7006 - `"output_file_too_large"`
7007
7008 - `type: "bash_code_execution_tool_result_error"`
7009
7010 default: bash_code_execution_tool_result_error
7011
7012 - `BashCodeExecutionResultBlock object`
7013
7014 - `content: array of BashCodeExecutionOutputBlock`
7015
7016 - `file_id: string`
7017
7018 - `type: "bash_code_execution_output"`
7019
7020 default: bash_code_execution_output
7021
7022 - `return_code: number`
7023
7024 - `stderr: string`
7025
7026 - `stdout: string`
7027
7028 - `type: "bash_code_execution_result"`
7029
7030 default: bash_code_execution_result
7111 - `"file_not_found"`
7112
7113 - `error_message: string or null`
7114
7115 - `TextEditorCodeExecutionViewResultBlock object`
7116
7117 - `type: "text_editor_code_execution_view_result"`
7118
7119 default: text_editor_code_execution_view_result
7120
7121 - `content: string`
7122
7123 - `file_type: "text" or "image" or "pdf"`
7124
7125 - `"text"`
7126
7127 - `"image"`
7128
7129 - `"pdf"`
7130
7131 - `num_lines: number or null`
7132
7133 - `start_line: number or null`
7134
7135 - `total_lines: number or null`
7136
7137 - `TextEditorCodeExecutionCreateResultBlock object`
7138
7139 - `type: "text_editor_code_execution_create_result"`
7140
7141 default: text_editor_code_execution_create_result
7142
7143 - `is_file_update: boolean`
7144
7145 - `TextEditorCodeExecutionStrReplaceResultBlock object`
7146
7147 - `type: "text_editor_code_execution_str_replace_result"`
7148
7149 default: text_editor_code_execution_str_replace_result
7150
7151 - `lines: array of string or null`
7152
7153 - `new_lines: number or null`
7154
7155 - `new_start: number or null`
7156
7157 - `old_lines: number or null`
7158
7159 - `old_start: number or null`
70317160
70327161 - `tool_use_id: string`
70337162
70347163 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
70357164
7036 - `type: "bash_code_execution_tool_result"`
7037
7038 default: bash_code_execution_tool_result
7039
7040 - `TextEditorCodeExecutionToolResultBlock object`
7041
7042 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
7043
7044 - `TextEditorCodeExecutionToolResultError object`
7045
7046 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
7165 - `ToolSearchToolResultBlock object`
7166
7167 - `type: "tool_search_tool_result"`
7168
7169 default: tool_search_tool_result
7170
7171 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
7172
7173 - `ToolSearchToolResultError object`
7174
7175 - `type: "tool_search_tool_result_error"`
7176
7177 default: tool_search_tool_result_error
7178
7179 - `error_code: ToolSearchToolResultErrorCode`
70477180
70487181 - `"invalid_tool_input"`
70497182
from line 7186
70537186
70547187 - `"execution_time_exceeded"`
70557188
7056 - `"file_not_found"`
7057
70587189 - `error_message: string or null`
70597190
7060 - `type: "text_editor_code_execution_tool_result_error"`
7061
7062 default: text_editor_code_execution_tool_result_error
7063
7064 - `TextEditorCodeExecutionViewResultBlock object`
7065
7066 - `content: string`
7067
7068 - `file_type: "text" or "image" or "pdf"`
7069
7070 - `"text"`
7071
7072 - `"image"`
7073
7074 - `"pdf"`
7075
7076 - `num_lines: number or null`
7077
7078 - `start_line: number or null`
7079
7080 - `total_lines: number or null`
7081
7082 - `type: "text_editor_code_execution_view_result"`
7083
7084 default: text_editor_code_execution_view_result
7085
7086 - `TextEditorCodeExecutionCreateResultBlock object`
7087
7088 - `is_file_update: boolean`
7089
7090 - `type: "text_editor_code_execution_create_result"`
7091
7092 default: text_editor_code_execution_create_result
7093
7094 - `TextEditorCodeExecutionStrReplaceResultBlock object`
7095
7096 - `lines: array of string or null`
7097
7098 - `new_lines: number or null`
7099
7100 - `new_start: number or null`
7101
7102 - `old_lines: number or null`
7103
7104 - `old_start: number or null`
7105
7106 - `type: "text_editor_code_execution_str_replace_result"`
7107
7108 default: text_editor_code_execution_str_replace_result
7191 - `ToolSearchToolSearchResultBlock object`
7192
7193 - `type: "tool_search_tool_search_result"`
7194
7195 default: tool_search_tool_search_result
7196
7197 - `tool_references: array of ToolReferenceBlock`
7198
7199 - `type: "tool_reference"`
7200
7201 default: tool_reference
7202
7203 - `tool_name: string`
7204
7205 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
71097206
71107207 - `tool_use_id: string`
71117208
71127209 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
71137210
7114 - `type: "text_editor_code_execution_tool_result"`
7115
7116 default: text_editor_code_execution_tool_result
7117
7118 - `ToolSearchToolResultBlock object`
7119
7120 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
7121
7122 - `ToolSearchToolResultError object`
7123
7124 - `error_code: ToolSearchToolResultErrorCode`
7125
7126 - `"invalid_tool_input"`
7127
7128 - `"unavailable"`
7129
7130 - `"too_many_requests"`
7131
7132 - `"execution_time_exceeded"`
7133
7134 - `error_message: string or null`
7135
7136 - `type: "tool_search_tool_result_error"`
7137
7138 default: tool_search_tool_result_error
7139
7140 - `ToolSearchToolSearchResultBlock object`
7141
7142 - `tool_references: array of ToolReferenceBlock`
7143
7144 - `tool_name: string`
7145
7146 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
7147
7148 - `type: "tool_reference"`
7149
7150 default: tool_reference
7151
7152 - `type: "tool_search_tool_search_result"`
7153
7154 default: tool_search_tool_search_result
7155
7156 - `tool_use_id: string`
7157
7158 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
7159
7160 - `type: "tool_search_tool_result"`
7161
7162 default: tool_search_tool_result
7163
71647211 - `ContainerUploadBlock object`
71657212
71667213 Response model for a file uploaded to the container.
71677214
7215 - `type: "container_upload"`
7216
7217 default: container_upload
7218
71687219 - `file_id: string`
71697220
7170 - `type: "container_upload"`
7171
7172 default: container_upload
7173
71747221 - `model: Model`
71757222
71767223 The model that will complete your prompt.
from line 7312
72657312
72667313 Structured information about a refusal.
72677314
7315 - `type: "refusal"`
7316
7317 default: refusal
7318
72687319 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
72697320
72707321 The policy category that triggered a refusal.
from line 7345
72947345 Human-readable explanation of the refusal.
72957346
72967347 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
7297
7298 - `type: "refusal"`
7299
7300 default: refusal
73017348
73027349 - `stop_reason: StopReason or null`
73037350
from line 7382
73357382
73367383 This value will be a non-null string if one of your custom stop sequences was generated.
73377384
7338 - `type: "message"`
7339
7340 Object type.
7341
7342 For Messages, this is always `"message"`.
7343
7344 default: message
7345
73467385 - `usage: Usage`
73477386
73487387 Billing and rate-limit usage.
from line 7486
74477486
74487487 - `"batch"`
74497488
7450 - `type: "succeeded"`
7451
7452 default: succeeded
7453
74547489 - `MessageBatchErroredResult object`
74557490
7491 - `type: "errored"`
7492
7493 default: errored
7494
74567495 - `error: ErrorResponse`
74577496
7497 - `type: "error"`
7498
7499 default: error
7500
74587501 - `error: ErrorObject`
74597502
74607503 - `InvalidRequestError object`
74617504
7505 - `type: "invalid_request_error"`
7506
7507 default: invalid_request_error
7508
74627509 - `message: string`
74637510
74647511 default: Invalid request
74657512
7466 - `type: "invalid_request_error"`
7467
7468 default: invalid_request_error
7469
74707513 - `AuthenticationError object`
74717514
7515 - `type: "authentication_error"`
7516
7517 default: authentication_error
7518
74727519 - `message: string`
74737520
74747521 default: Authentication error
74757522
7476 - `type: "authentication_error"`
7477
7478 default: authentication_error
7479
74807523 - `BillingError object`
74817524
7525 - `type: "billing_error"`
7526
7527 default: billing_error
7528
74827529 - `message: string`
74837530
74847531 default: Billing error
74857532
7486 - `type: "billing_error"`
7487
7488 default: billing_error
7489
74907533 - `PermissionError object`
74917534
7535 - `type: "permission_error"`
7536
7537 default: permission_error
7538
74927539 - `message: string`
74937540
74947541 default: Permission denied
74957542
7496 - `type: "permission_error"`
7497
7498 default: permission_error
7499
75007543 - `NotFoundError object`
75017544
7545 - `type: "not_found_error"`
7546
7547 default: not_found_error
7548
75027549 - `message: string`
75037550
75047551 default: Not found
75057552
7506 - `type: "not_found_error"`
7507
7508 default: not_found_error
7509
75107553 - `RateLimitError object`
75117554
7555 - `type: "rate_limit_error"`
7556
7557 default: rate_limit_error
7558
75127559 - `message: string`
75137560
75147561 default: Rate limited
75157562
7516 - `type: "rate_limit_error"`
7517
7518 default: rate_limit_error
7519
75207563 - `GatewayTimeoutError object`
75217564
7565 - `type: "timeout_error"`
7566
7567 default: timeout_error
7568
75227569 - `message: string`
75237570
75247571 default: Request timeout
75257572
7526 - `type: "timeout_error"`
7527
7528 default: timeout_error
7529
75307573 - `APIErrorObject object`
75317574
7575 - `type: "api_error"`
7576
7577 default: api_error
7578
75327579 - `message: string`
75337580
75347581 default: Internal server error
75357582
7536 - `type: "api_error"`
7537
7538 default: api_error
7539
75407583 - `OverloadedError object`
75417584
7585 - `type: "overloaded_error"`
7586
7587 default: overloaded_error
7588
75427589 - `message: string`
75437590
75447591 default: Overloaded
75457592
7546 - `type: "overloaded_error"`
7547
7548 default: overloaded_error
7549
75507593 - `request_id: string or null`
75517594
7552 - `type: "error"`
7553
7554 default: error
7555
7556 - `type: "errored"`
7557
7558 default: errored
7559
75607595 - `MessageBatchCanceledResult object`
75617596
75627597 - `type: "canceled"`
from line 7608
75737608
75747609- `MessageBatchSucceededResult object`
75757610
7611 - `type: "succeeded"`
7612
7613 default: succeeded
7614
75767615 - `message: Message`
75777616
7617 - `type: "message"`
7618
7619 Object type.
7620
7621 For Messages, this is always `"message"`.
7622
7623 default: message
7624
75787625 - `id: string`
75797626
75807627 Unique object identifier.
from line 7646
75997646
76007647 Skills loaded in the container
76017648
7649 - `type: "anthropic" or "custom"`
7650
7651 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
7652
7653 - `"anthropic"`
7654
7655 - `"custom"`
7656
76027657 - `skill_id: string`
76037658
76047659 Skill ID
76057660
76067661 maxLength: 64, minLength: 1
7607
7608 - `type: "anthropic" or "custom"`
7609
7610 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
7611
7612 - `"anthropic"`
7613
7614 - `"custom"`
76157662
76167663 - `version: string`
76177664
from line 7697
76507697
76517698 - `TextBlock object`
76527699
7700 - `type: "text"`
7701
7702 default: text
7703
76537704 - `citations: array of TextCitation or null`
76547705
76557706 Citations supporting the text block.
from line 7709
76587709
76597710 - `CitationCharLocation object`
76607711
7712 - `type: "char_location"`
7713
7714 default: char_location
7715
76617716 - `cited_text: string`
76627717
76637718 - `document_index: number`
from line 7729
76747729
76757730 minimum: 0
76767731
7677 - `type: "char_location"`
7678
7679 default: char_location
7680
76817732 - `CitationPageLocation object`
76827733
7734 - `type: "page_location"`
7735
7736 default: page_location
7737
76837738 - `cited_text: string`
76847739
76857740 - `document_index: number`
from line 7751
76967751
76977752 minimum: 1
76987753
7699 - `type: "page_location"`
7700
7701 default: page_location
7702
77037754 - `CitationContentBlockLocation object`
77047755
7756 - `type: "content_block_location"`
7757
7758 default: content_block_location
7759
77057760 - `cited_text: string`
77067761
77077762 The full text of the cited block range, concatenated.
from line 7783
77287783
77297784 minimum: 0
77307785
7731 - `type: "content_block_location"`
7732
7733 default: content_block_location
7734
77357786 - `CitationsWebSearchResultLocation object`
77367787
7788 - `type: "web_search_result_location"`
7789
7790 default: web_search_result_location
7791
77377792 - `cited_text: string`
77387793
77397794 - `encrypted_index: string`
from line 7797
77427797
77437798 maxLength: 512
77447799
7745 - `type: "web_search_result_location"`
7746
7747 default: web_search_result_location
7748
77497800 - `url: string`
77507801
77517802 - `CitationsSearchResultLocation object`
77527803
7804 - `type: "search_result_location"`
7805
7806 default: search_result_location
7807
77537808 - `cited_text: string`
77547809
77557810 The full text of the cited block range, concatenated.
from line 7835
77807835
77817836 - `title: string or null`
77827837
7783 - `type: "search_result_location"`
7784
7785 default: search_result_location
7786
77877838 - `text: string`
77887839
7789 maxLength: 5000000, minLength: 0
7790
7791 - `type: "text"`
7792
7793 default: text
7840 minLength: 0
77947841
77957842 - `ThinkingBlock object`
77967843
7844 - `type: "thinking"`
7845
7846 default: thinking
7847
77977848 - `signature: string`
77987849
77997850 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 7857
78067857
78077858 The text of Claude's thinking process for this block.
78087859
7809 - `type: "thinking"`
7810
7811 default: thinking
7812
78137860 - `RedactedThinkingBlock object`
78147861
7862 - `type: "redacted_thinking"`
7863
7864 default: redacted_thinking
7865
78157866 - `data: string`
78167867
78177868 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 7871
78207871
78217872 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
78227873
7823 - `type: "redacted_thinking"`
7824
7825 default: redacted_thinking
7826
78277874 - `ToolUseBlock object`
78287875
7876 - `type: "tool_use"`
7877
7878 default: tool_use
7879
78297880 - `id: string`
78307881
78317882 pattern: ^[a-zA-Z0-9_-]+$
from line 7897
78467897
78477898 Tool invocation generated by a server-side tool.
78487899
7900 - `type: "code_execution_20250825"`
7901
78497902 - `tool_id: string`
78507903
78517904 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
78527905
7853 - `type: "code_execution_20250825"`
7854
78557906 - `ServerToolCaller20260120 object`
78567907
7908 - `type: "code_execution_20260120"`
7909
78577910 - `tool_id: string`
78587911
78597912 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
78607913
7861 - `type: "code_execution_20260120"`
7862
78637914 - `input: map[unknown]`
78647915
78657916 - `name: string`
78667917
78677918 minLength: 1
78687919
7869 - `type: "tool_use"`
7870
7871 default: tool_use
7872
78737920 - `toolset_name: optional string or null`
78747921
78757922 For a toolset member tool_use, the toolset family.
from line 7925
78787925
78797926 - `ServerToolUseBlock object`
78807927
7928 - `type: "server_tool_use"`
7929
7930 default: server_tool_use
7931
78817932 - `id: string`
78827933
78837934 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 7967
79167967
79177968 - `"tool_search_tool_bm25"`
79187969
7919 - `type: "server_tool_use"`
7920
7921 default: server_tool_use
7922
79237970 - `WebSearchToolResultBlock object`
79247971
7972 - `type: "web_search_tool_result"`
7973
7974 default: web_search_tool_result
7975
79257976 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
79267977
79277978 Tool invocation directly from the model.
from line 7993
79427993
79437994 - `WebSearchToolResultError object`
79447995
7996 - `type: "web_search_tool_result_error"`
7997
7998 default: web_search_tool_result_error
7999
79458000 - `error_code: WebSearchToolResultErrorCode`
79468001
79478002 - `"invalid_tool_input"`
from line 8011
79568011
79578012 - `"request_too_large"`
79588013
7959 - `type: "web_search_tool_result_error"`
7960
7961 default: web_search_tool_result_error
7962
79638014 - `array of WebSearchResultBlock`
79648015
8016 - `type: "web_search_result"`
8017
8018 default: web_search_result
8019
79658020 - `encrypted_content: string`
79668021
79678022 - `page_age: string or null`
79688023
79698024 - `title: string`
79708025
7971 - `type: "web_search_result"`
7972
7973 default: web_search_result
7974
79758026 - `url: string`
79768027
79778028 - `tool_use_id: string`
79788029
79798030 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
79808031
7981 - `type: "web_search_tool_result"`
7982
7983 default: web_search_tool_result
7984
79858032 - `WebFetchToolResultBlock object`
79868033
8034 - `type: "web_fetch_tool_result"`
8035
8036 default: web_fetch_tool_result
8037
79878038 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
79888039
79898040 Tool invocation directly from the model.
from line 8055
80048055
80058056 - `WebFetchToolResultErrorBlock object`
80068057
8058 - `type: "web_fetch_tool_result_error"`
8059
8060 default: web_fetch_tool_result_error
8061
80078062 - `error_code: WebFetchToolResultErrorCode`
80088063
80098064 - `"invalid_tool_input"`
from line 8079
80248079
80258080 - `"unavailable"`
80268081
8027 - `type: "web_fetch_tool_result_error"`
8028
8029 default: web_fetch_tool_result_error
8082 - `"content_too_large"`
80308083
80318084 - `WebFetchBlock object`
80328085
8086 - `type: "web_fetch_result"`
8087
8088 default: web_fetch_result
8089
80338090 - `content: DocumentBlock`
80348091
8092 - `type: "document"`
8093
8094 default: document
8095
80358096 - `citations: CitationsConfig or null`
80368097
80378098 Citation configuration for the document
from line 8105
80448105
80458106 - `Base64PDFSource object`
80468107
8108 - `type: "base64"`
8109
80478110 - `data: string`
80488111
80498112 format: byte
80508113
80518114 - `media_type: "application/pdf"`
80528115
8053 - `type: "base64"`
8054
80558116 - `PlainTextSource object`
80568117
8118 - `type: "text"`
8119
80578120 - `data: string`
80588121
80598122 - `media_type: "text/plain"`
80608123
8061 - `type: "text"`
8062
80638124 - `title: string or null`
80648125
80658126 The title of the document
80668127
8067 - `type: "document"`
8068
8069 default: document
8070
80718128 - `retrieved_at: string or null`
80728129
80738130 ISO 8601 timestamp when the content was retrieved
80748131
8075 - `type: "web_fetch_result"`
8076
8077 default: web_fetch_result
8078
80798132 - `url: string`
80808133
80818134 Fetched content URL
from line 8137
80848137
80858138 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
80868139
8087 - `type: "web_fetch_tool_result"`
8088
8089 default: web_fetch_tool_result
8090
80918140 - `CodeExecutionToolResultBlock object`
80928141
8142 - `type: "code_execution_tool_result"`
8143
8144 default: code_execution_tool_result
8145
80938146 - `content: CodeExecutionToolResultBlockContent`
80948147
80958148 Code execution result with encrypted stdout for PFC + web_search results.
80968149
80978150 - `CodeExecutionToolResultError object`
80988151
8152 - `type: "code_execution_tool_result_error"`
8153
8154 default: code_execution_tool_result_error
8155
80998156 - `error_code: CodeExecutionToolResultErrorCode`
81008157
81018158 - `"invalid_tool_input"`
from line 8163
81068163
81078164 - `"execution_time_exceeded"`
81088165
8109 - `type: "code_execution_tool_result_error"`
8110
8111 default: code_execution_tool_result_error
8112
81138166 - `CodeExecutionResultBlock object`
81148167
8168 - `type: "code_execution_result"`
8169
8170 default: code_execution_result
8171
81158172 - `content: array of CodeExecutionOutputBlock`
81168173
8174 - `type: "code_execution_output"`
8175
8176 default: code_execution_output
8177
81178178 - `file_id: string`
81188179
8180 - `return_code: number`
8181
8182 - `stderr: string`
8183
8184 - `stdout: string`
8185
8186 - `EncryptedCodeExecutionResultBlock object`
8187
8188 Code execution result with encrypted stdout for PFC + web_search results.
8189
8190 - `type: "encrypted_code_execution_result"`
8191
8192 default: encrypted_code_execution_result
8193
8194 - `content: array of CodeExecutionOutputBlock`
8195
81198196 - `type: "code_execution_output"`
81208197
81218198 default: code_execution_output
81228199
8200 - `file_id: string`
8201
8202 - `encrypted_stdout: string`
8203
81238204 - `return_code: number`
81248205
81258206 - `stderr: string`
81268207
8208 - `tool_use_id: string`
8209
8210 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
8211
8212 - `BashCodeExecutionToolResultBlock object`
8213
8214 - `type: "bash_code_execution_tool_result"`
8215
8216 default: bash_code_execution_tool_result
8217
8218 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
8219
8220 - `BashCodeExecutionToolResultError object`
8221
8222 - `type: "bash_code_execution_tool_result_error"`
8223
8224 default: bash_code_execution_tool_result_error
8225
8226 - `error_code: BashCodeExecutionToolResultErrorCode`
8227
8228 - `"invalid_tool_input"`
8229
8230 - `"unavailable"`
8231
8232 - `"too_many_requests"`
8233
8234 - `"execution_time_exceeded"`
8235
8236 - `"output_file_too_large"`
8237
8238 - `BashCodeExecutionResultBlock object`
8239
8240 - `type: "bash_code_execution_result"`
8241
8242 default: bash_code_execution_result
8243
8244 - `content: array of BashCodeExecutionOutputBlock`
8245
8246 - `type: "bash_code_execution_output"`
8247
8248 default: bash_code_execution_output
8249
8250 - `file_id: string`
8251
8252 - `return_code: number`
8253
8254 - `stderr: string`
8255
81278256 - `stdout: string`
81288257
8129 - `type: "code_execution_result"`
8130
8131 default: code_execution_result
8132
8133 - `EncryptedCodeExecutionResultBlock object`
8134
8135 Code execution result with encrypted stdout for PFC + web_search results.
8136
8137 - `content: array of CodeExecutionOutputBlock`
8138
8139 - `file_id: string`
8140
8141 - `type: "code_execution_output"`
8142
8143 default: code_execution_output
8144
8145 - `encrypted_stdout: string`
8146
8147 - `return_code: number`
8148
8149 - `stderr: string`
8150
8151 - `type: "encrypted_code_execution_result"`
8152
8153 default: encrypted_code_execution_result
8154
81558258 - `tool_use_id: string`
81568259
81578260 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
81588261
8159 - `type: "code_execution_tool_result"`
8160
8161 default: code_execution_tool_result
8162
8163 - `BashCodeExecutionToolResultBlock object`
8164
8165 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
8166
8167 - `BashCodeExecutionToolResultError object`
8168
8169 - `error_code: BashCodeExecutionToolResultErrorCode`
8262 - `TextEditorCodeExecutionToolResultBlock object`
8263
8264 - `type: "text_editor_code_execution_tool_result"`
8265
8266 default: text_editor_code_execution_tool_result
8267
8268 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
8269
8270 - `TextEditorCodeExecutionToolResultError object`
8271
8272 - `type: "text_editor_code_execution_tool_result_error"`
8273
8274 default: text_editor_code_execution_tool_result_error
8275
8276 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
81708277
81718278 - `"invalid_tool_input"`
81728279
from line 8283
81768283
81778284 - `"execution_time_exceeded"`
81788285
8179 - `"output_file_too_large"`
8180
8181 - `type: "bash_code_execution_tool_result_error"`
8182
8183 default: bash_code_execution_tool_result_error
8184
8185 - `BashCodeExecutionResultBlock object`
8186
8187 - `content: array of BashCodeExecutionOutputBlock`
8188
8189 - `file_id: string`
8190
8191 - `type: "bash_code_execution_output"`
8192
8193 default: bash_code_execution_output
8194
8195 - `return_code: number`
8196
8197 - `stderr: string`
8198
8199 - `stdout: string`
8200
8201 - `type: "bash_code_execution_result"`
8202
8203 default: bash_code_execution_result
8286 - `"file_not_found"`
8287
8288 - `error_message: string or null`
8289
8290 - `TextEditorCodeExecutionViewResultBlock object`
8291
8292 - `type: "text_editor_code_execution_view_result"`
8293
8294 default: text_editor_code_execution_view_result
8295
8296 - `content: string`
8297
8298 - `file_type: "text" or "image" or "pdf"`
8299
8300 - `"text"`
8301
8302 - `"image"`
8303
8304 - `"pdf"`
8305
8306 - `num_lines: number or null`
8307
8308 - `start_line: number or null`
8309
8310 - `total_lines: number or null`
8311
8312 - `TextEditorCodeExecutionCreateResultBlock object`
8313
8314 - `type: "text_editor_code_execution_create_result"`
8315
8316 default: text_editor_code_execution_create_result
8317
8318 - `is_file_update: boolean`
8319
8320 - `TextEditorCodeExecutionStrReplaceResultBlock object`
8321
8322 - `type: "text_editor_code_execution_str_replace_result"`
8323
8324 default: text_editor_code_execution_str_replace_result
8325
8326 - `lines: array of string or null`
8327
8328 - `new_lines: number or null`
8329
8330 - `new_start: number or null`
8331
8332 - `old_lines: number or null`
8333
8334 - `old_start: number or null`
82048335
82058336 - `tool_use_id: string`
82068337
82078338 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
82088339
8209 - `type: "bash_code_execution_tool_result"`
8210
8211 default: bash_code_execution_tool_result
8212
8213 - `TextEditorCodeExecutionToolResultBlock object`
8214
8215 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
8216
8217 - `TextEditorCodeExecutionToolResultError object`
8218
8219 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
8340 - `ToolSearchToolResultBlock object`
8341
8342 - `type: "tool_search_tool_result"`
8343
8344 default: tool_search_tool_result
8345
8346 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
8347
8348 - `ToolSearchToolResultError object`
8349
8350 - `type: "tool_search_tool_result_error"`
8351
8352 default: tool_search_tool_result_error
8353
8354 - `error_code: ToolSearchToolResultErrorCode`
82208355
82218356 - `"invalid_tool_input"`
82228357
from line 8361
82268361
82278362 - `"execution_time_exceeded"`
82288363
8229 - `"file_not_found"`
8230
82318364 - `error_message: string or null`
82328365
8233 - `type: "text_editor_code_execution_tool_result_error"`
8234
8235 default: text_editor_code_execution_tool_result_error
8236
8237 - `TextEditorCodeExecutionViewResultBlock object`
8238
8239 - `content: string`
8240
8241 - `file_type: "text" or "image" or "pdf"`
8242
8243 - `"text"`
8244
8245 - `"image"`
8246
8247 - `"pdf"`
8248
8249 - `num_lines: number or null`
8250
8251 - `start_line: number or null`
8252
8253 - `total_lines: number or null`
8254
8255 - `type: "text_editor_code_execution_view_result"`
8256
8257 default: text_editor_code_execution_view_result
8258
8259 - `TextEditorCodeExecutionCreateResultBlock object`
8260
8261 - `is_file_update: boolean`
8262
8263 - `type: "text_editor_code_execution_create_result"`
8264
8265 default: text_editor_code_execution_create_result
8266
8267 - `TextEditorCodeExecutionStrReplaceResultBlock object`
8268
8269 - `lines: array of string or null`
8270
8271 - `new_lines: number or null`
8272
8273 - `new_start: number or null`
8274
8275 - `old_lines: number or null`
8276
8277 - `old_start: number or null`
8278
8279 - `type: "text_editor_code_execution_str_replace_result"`
8280
8281 default: text_editor_code_execution_str_replace_result
8366 - `ToolSearchToolSearchResultBlock object`
8367
8368 - `type: "tool_search_tool_search_result"`
8369
8370 default: tool_search_tool_search_result
8371
8372 - `tool_references: array of ToolReferenceBlock`
8373
8374 - `type: "tool_reference"`
8375
8376 default: tool_reference
8377
8378 - `tool_name: string`
8379
8380 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
82828381
82838382 - `tool_use_id: string`
82848383
82858384 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
82868385
8287 - `type: "text_editor_code_execution_tool_result"`
8288
8289 default: text_editor_code_execution_tool_result
8290
8291 - `ToolSearchToolResultBlock object`
8292
8293 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
8294
8295 - `ToolSearchToolResultError object`
8296
8297 - `error_code: ToolSearchToolResultErrorCode`
8298
8299 - `"invalid_tool_input"`
8300
8301 - `"unavailable"`
8302
8303 - `"too_many_requests"`
8304
8305 - `"execution_time_exceeded"`
8306
8307 - `error_message: string or null`
8308
8309 - `type: "tool_search_tool_result_error"`
8310
8311 default: tool_search_tool_result_error
8312
8313 - `ToolSearchToolSearchResultBlock object`
8314
8315 - `tool_references: array of ToolReferenceBlock`
8316
8317 - `tool_name: string`
8318
8319 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
8320
8321 - `type: "tool_reference"`
8322
8323 default: tool_reference
8324
8325 - `type: "tool_search_tool_search_result"`
8326
8327 default: tool_search_tool_search_result
8328
8329 - `tool_use_id: string`
8330
8331 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
8332
8333 - `type: "tool_search_tool_result"`
8334
8335 default: tool_search_tool_result
8336
83378386 - `ContainerUploadBlock object`
83388387
83398388 Response model for a file uploaded to the container.
83408389
8390 - `type: "container_upload"`
8391
8392 default: container_upload
8393
83418394 - `file_id: string`
83428395
8343 - `type: "container_upload"`
8344
8345 default: container_upload
8346
83478396 - `model: Model`
83488397
83498398 The model that will complete your prompt.
from line 8487
84388487
84398488 Structured information about a refusal.
84408489
8490 - `type: "refusal"`
8491
8492 default: refusal
8493
84418494 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
84428495
84438496 The policy category that triggered a refusal.
from line 8520
84678520 Human-readable explanation of the refusal.
84688521
84698522 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
8470
8471 - `type: "refusal"`
8472
8473 default: refusal
84748523
84758524 - `stop_reason: StopReason or null`
84768525
from line 8557
85088557
85098558 This value will be a non-null string if one of your custom stop sequences was generated.
85108559
8511 - `type: "message"`
8512
8513 Object type.
8514
8515 For Messages, this is always `"message"`.
8516
8517 default: message
8518
85198560 - `usage: Usage`
85208561
85218562 Billing and rate-limit usage.
from line 8660
86198660 - `"priority"`
86208661
86218662 - `"batch"`
8622
8623 - `type: "succeeded"`
8624
8625 default: succeeded
86268663
api/messages/batches/cancel Changed · +17 / -8 lines
## Headers
from line 1
1---
2title: Cancel a Message Batch
3url: https://platform.claude.com/docs/en/api/messages/batches/cancel
4---
5
16# Cancel a Message Batch
27
38**POST** `/v1/messages/batches/{message_batch_id}/cancel`
from line 19
1419
1520 ID of the Message Batch.
1621
22## Headers
23
24- `"anthropic-workspace-id": optional string`
25
1726## Returns
1827
1928- `MessageBatch object`
2029
30 - `type: "message_batch"`
31
32 Object type.
33
34 For Message Batches, this is always `"message_batch"`.
35
36 default: message_batch
37
2138 - `id: string`
2239
2340 Unique object identifier.
from line 132
115132 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
116133
117134 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
118
119 - `type: "message_batch"`
120
121 Object type.
122
123 For Message Batches, this is always `"message_batch"`.
124
125 default: message_batch
126135
127136## Example
128137
api/messages/batches/create Changed · +473 / -464 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: Create a Message Batch
3url: https://platform.claude.com/docs/en/api/messages/batches/create
4---
5
16# Create a Message Batch
27
38**POST** `/v1/messages/batches`
from line 18
1318- `"anthropic-user-profile-id": optional string`
1419
1520 The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored.
21
22- `"anthropic-workspace-id": optional string`
1623
1724## Body parameters
1825
from line 114
107114
108115 - `TextBlockParam object`
109116
117 - `type: "text"`
118
110119 - `text: string`
111120
112121 minLength: 1
113
114 - `type: "text"`
115122
116123 - `cache_control: optional CacheControlEphemeral or null`
117124
from line 145
138145
139146 - `CitationCharLocationParam object`
140147
148 - `type: "char_location"`
149
141150 - `cited_text: string`
142151
143152 - `document_index: number`
from line 163
154163
155164 minimum: 0
156165
157 - `type: "char_location"`
158
159166 - `CitationPageLocationParam object`
160167
168 - `type: "page_location"`
169
161170 - `cited_text: string`
162171
163172 - `document_index: number`
from line 183
174183
175184 minimum: 1
176185
177 - `type: "page_location"`
178
179186 - `CitationContentBlockLocationParam object`
180187
188 - `type: "content_block_location"`
189
181190 - `cited_text: string`
182191
183192 The full text of the cited block range, concatenated.
from line 213
204213
205214 minimum: 0
206215
207 - `type: "content_block_location"`
208
209216 - `CitationWebSearchResultLocationParam object`
210217
218 - `type: "web_search_result_location"`
219
211220 - `cited_text: string`
212221
213222 - `encrypted_index: string`
from line 225
216225
217226 maxLength: 512, minLength: 1
218227
219 - `type: "web_search_result_location"`
220
221228 - `url: string`
222229
223230 minLength: 1
224231
225232 - `CitationSearchResultLocationParam object`
226233
234 - `type: "search_result_location"`
235
227236 - `cited_text: string`
228237
229238 The full text of the cited block range, concatenated.
from line 263
254263
255264 - `title: string or null`
256265
257 - `type: "search_result_location"`
258
259266 - `ImageBlockParam object`
260267
268 - `type: "image"`
269
261270 - `source: Base64ImageSource or URLImageSource or FileImageSource`
262271
263272 - `Base64ImageSource object`
264273
274 - `type: "base64"`
275
265276 - `data: string`
266277
267278 format: byte
from line 287
276287
277288 - `"image/webp"`
278289
290 - `URLImageSource object`
291
292 - `type: "url"`
293
294 - `url: string`
295
296 - `FileImageSource object`
297
298 - `type: "file"`
299
300 - `file_id: string`
301
302 - `cache_control: optional CacheControlEphemeral or null`
303
304 Create a cache control breakpoint at this content block.
305
306 - `transformations: optional ImageTransformationsParam or null`
307
308 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
309
310 - `oversized_image: optional "downsize" or "error"`
311
312 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
313
314 - `"downsize"`
315
316 - `"error"`
317
318 - `DocumentBlockParam object`
319
320 - `type: "document"`
321
322 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
323
324 - `Base64PDFSource object`
325
279326 - `type: "base64"`
280327
281 - `URLImageSource object`
328 - `data: string`
329
330 format: byte
331
332 - `media_type: "application/pdf"`
333
334 - `PlainTextSource object`
335
336 - `type: "text"`
337
338 - `data: string`
339
340 - `media_type: "text/plain"`
341
342 - `ContentBlockSource object`
343
344 - `type: "content"`
345
346 - `content: string or array of ContentBlockSourceContent`
347
348 - `string`
349
350 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
351
352 - `TextBlockParam object`
353
354 - `ImageBlockParam object`
355
356 - `URLPDFSource object`
282357
283358 - `type: "url"`
284359
285360 - `url: string`
286361
287 - `FileImageSource object`
362 - `FileDocumentSource object`
363
364 - `type: "file"`
288365
289366 - `file_id: string`
290367
291 - `type: "file"`
292
293 - `type: "image"`
294
295368 - `cache_control: optional CacheControlEphemeral or null`
296369
297370 Create a cache control breakpoint at this content block.
298371
299 - `transformations: optional ImageTransformationsParam or null`
300
301 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
302
303 - `oversized_image: optional "downsize" or "error"`
304
305 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
306
307 - `"downsize"`
308
309 - `"error"`
310
311 - `DocumentBlockParam object`
312
313 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
314
315 - `Base64PDFSource object`
316
317 - `data: string`
318
319 format: byte
320
321 - `media_type: "application/pdf"`
322
323 - `type: "base64"`
324
325 - `PlainTextSource object`
326
327 - `data: string`
328
329 - `media_type: "text/plain"`
330
331 - `type: "text"`
332
333 - `ContentBlockSource object`
334
335 - `content: string or array of ContentBlockSourceContent`
336
337 - `string`
338
339 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
340
341 - `TextBlockParam object`
342
343 - `ImageBlockParam object`
344
345 - `type: "content"`
346
347 - `URLPDFSource object`
348
349 - `type: "url"`
350
351 - `url: string`
352
353 - `FileDocumentSource object`
354
355 - `file_id: string`
356
357 - `type: "file"`
358
359 - `type: "document"`
372 - `citations: optional CitationsConfigParam or null`
373
374 - `enabled: optional boolean`
375
376 - `context: optional string or null`
377
378 minLength: 1
379
380 - `title: optional string or null`
381
382 maxLength: 500, minLength: 1
383
384 - `SearchResultBlockParam object`
385
386 - `type: "search_result"`
387
388 - `content: array of TextBlockParam`
389
390 - `type: "text"`
391
392 - `text: string`
393
394 minLength: 1
395
396 - `cache_control: optional CacheControlEphemeral or null`
397
398 Create a cache control breakpoint at this content block.
399
400 - `citations: optional array of TextCitationParam or null`
401
402 - `source: string`
403
404 - `title: string`
360405
361406 - `cache_control: optional CacheControlEphemeral or null`
362407
363408 Create a cache control breakpoint at this content block.
364409
365 - `citations: optional CitationsConfigParam or null`
366
367 - `enabled: optional boolean`
368
369 - `context: optional string or null`
370
371 minLength: 1
372
373 - `title: optional string or null`
374
375 maxLength: 500, minLength: 1
376
377 - `SearchResultBlockParam object`
378
379 - `content: array of TextBlockParam`
380
381 - `text: string`
382
383 minLength: 1
384
385 - `type: "text"`
386
387 - `cache_control: optional CacheControlEphemeral or null`
388
389 Create a cache control breakpoint at this content block.
390
391 - `citations: optional array of TextCitationParam or null`
392
393 - `source: string`
394
395 - `title: string`
396
397 - `type: "search_result"`
410 - `citations: optional CitationsConfigParam`
411
412 - `ThinkingBlockParam object`
413
414 - `type: "thinking"`
415
416 - `signature: string`
417
418 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
419
420 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
421
422 - `thinking: string`
423
424 The `thinking` text of this block as returned by the API.
425
426 - `RedactedThinkingBlockParam object`
427
428 - `type: "redacted_thinking"`
429
430 - `data: string`
431
432 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
433
434 - `ToolUseBlockParam object`
435
436 - `type: "tool_use"`
437
438 - `id: string`
439
440 pattern: ^[a-zA-Z0-9_-]+$
441
442 - `input: map[unknown]`
443
444 - `name: string`
445
446 maxLength: 200, minLength: 1
398447
399448 - `cache_control: optional CacheControlEphemeral or null`
400449
401450 Create a cache control breakpoint at this content block.
402451
403 - `citations: optional CitationsConfigParam`
404
405 - `ThinkingBlockParam object`
406
407 - `signature: string`
408
409 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
410
411 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
412
413 - `thinking: string`
414
415 The `thinking` text of this block as returned by the API.
416
417 - `type: "thinking"`
418
419 - `RedactedThinkingBlockParam object`
420
421 - `data: string`
422
423 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
424
425 - `type: "redacted_thinking"`
426
427 - `ToolUseBlockParam object`
428
429 - `id: string`
452 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
453
454 Tool invocation directly from the model.
455
456 - `DirectCaller object`
457
458 Tool invocation directly from the model.
459
460 - `type: "direct"`
461
462 - `ServerToolCaller object`
463
464 Tool invocation generated by a server-side tool.
465
466 - `type: "code_execution_20250825"`
467
468 - `tool_id: string`
469
470 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
471
472 - `ServerToolCaller20260120 object`
473
474 - `type: "code_execution_20260120"`
475
476 - `tool_id: string`
477
478 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
479
480 - `toolset_name: optional string or null`
481
482 For a toolset member tool_use, the toolset family this member belongs to.
483
484 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
485
486 - `ToolResultBlockParam object`
487
488 - `type: "tool_result"`
489
490 - `tool_use_id: string`
430491
431492 pattern: ^[a-zA-Z0-9_-]+$
432493
433 - `input: map[unknown]`
434
435 - `name: string`
436
437 maxLength: 200, minLength: 1
438
439 - `type: "tool_use"`
440
441494 - `cache_control: optional CacheControlEphemeral or null`
442495
443496 Create a cache control breakpoint at this content block.
444497
445 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
446
447 Tool invocation directly from the model.
448
449 - `DirectCaller object`
450
451 Tool invocation directly from the model.
452
453 - `type: "direct"`
454
455 - `ServerToolCaller object`
456
457 Tool invocation generated by a server-side tool.
458
459 - `tool_id: string`
460
461 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
462
463 - `type: "code_execution_20250825"`
464
465 - `ServerToolCaller20260120 object`
466
467 - `tool_id: string`
468
469 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
470
471 - `type: "code_execution_20260120"`
472
473 - `toolset_name: optional string or null`
474
475 For a toolset member tool_use, the toolset family this member belongs to.
476
477 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
478
479 - `ToolResultBlockParam object`
480
481 - `tool_use_id: string`
482
483 pattern: ^[a-zA-Z0-9_-]+$
484
485 - `type: "tool_result"`
486
487 - `cache_control: optional CacheControlEphemeral or null`
488
489 Create a cache control breakpoint at this content block.
490
491498 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`
492499
493500 - `string`
from line 513
506513
507514 Tool reference block that can be included in tool_result content.
508515
516 - `type: "tool_reference"`
517
509518 - `tool_name: string`
510519
511520 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
512
513 - `type: "tool_reference"`
514521
515522 - `cache_control: optional CacheControlEphemeral or null`
516523
from line 533
526533 browser toolset member `tool_use`. The server renders the
527534 model-visible text from it; the model never sees the raw fields.
528535
536 - `type: "browser_state"`
537
529538 - `tabs: array of BrowserStateTabEntry`
530539
531540 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
from line 562
553562 - `active: optional boolean`
554563
555564 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
556
557 - `type: "browser_state"`
558565
559566 - `cache_control: optional CacheControlEphemeral or null`
560567
from line 583
576583 during a failed call gets no deferred `tab_opened`; it simply appears
577584 in the next result's `tabs` inventory.
578585
586 - `type: "tab_opened"`
587
579588 - `tab_id: string`
580589
581590 The `tab_id` of the opened tab, present in `tabs`.
582591
583592 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
584593
585 - `type: "tab_opened"`
586
587594 - `BrowserStateChangeDownloadStarted object`
588595
589596 A file download that started during this call.
590597
598 - `type: "download_started"`
599
591600 - `download_id: string`
592601
593602 The caller-assigned identifier for this download, stable across the state changes reporting it.
594603
595604 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
596
597 - `type: "download_started"`
598605
599606 - `url: string`
600607
from line 616
609616 `download_started`, when the download finished during the call that
610617 started it (at most one state change per `download_id` per result).
611618
619 - `type: "download_completed"`
620
612621 - `download_id: string`
613622
614623 The caller-assigned identifier for this download, stable across the state changes reporting it.
615624
616625 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
617626
618 - `type: "download_completed"`
619
620627 - `url: string`
621628
622629 The final post-redirect URL the download was served from.
from line 646
639646
640647 A file download that failed — or was cancelled — during this call.
641648
649 - `type: "download_failed"`
650
642651 - `download_id: string`
643652
644653 The caller-assigned identifier for this download, stable across the state changes reporting it.
645654
646655 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
647656
648 - `type: "download_failed"`
649
650657 - `url: string`
651658
652659 The final post-redirect URL the download was served from.
from line 676
669676
670677 - `ServerToolUseBlockParam object`
671678
679 - `type: "server_tool_use"`
680
672681 - `id: string`
673682
674683 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 700
691700
692701 - `"tool_search_tool_bm25"`
693702
694 - `type: "server_tool_use"`
695
696703 - `cache_control: optional CacheControlEphemeral or null`
697704
698705 Create a cache control breakpoint at this content block.
from line 720
713720
714721 - `WebSearchToolResultBlockParam object`
715722
723 - `type: "web_search_tool_result"`
724
716725 - `content: WebSearchToolResultBlockParamContent`
717726
718727 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`
719728
729 - `type: "web_search_result"`
730
720731 - `encrypted_content: string`
721732
722733 - `title: string`
723734
724 - `type: "web_search_result"`
725
726735 - `url: string`
727736
728737 - `page_age: optional string or null`
729738
730739 - `WebSearchToolRequestError object`
731740
741 - `type: "web_search_tool_result_error"`
742
732743 - `error_code: WebSearchToolResultErrorCode`
733744
734745 - `"invalid_tool_input"`
from line 754
743754
744755 - `"request_too_large"`
745756
746 - `type: "web_search_tool_result_error"`
747
748757 - `tool_use_id: string`
749758
750759 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
751760
752 - `type: "web_search_tool_result"`
753
754761 - `cache_control: optional CacheControlEphemeral or null`
755762
756763 Create a cache control breakpoint at this content block.
from line 778
771778
772779 - `WebFetchToolResultBlockParam object`
773780
781 - `type: "web_fetch_tool_result"`
782
774783 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`
775784
776785 - `WebFetchToolResultErrorBlockParam object`
777786
787 - `type: "web_fetch_tool_result_error"`
788
778789 - `error_code: WebFetchToolResultErrorCode`
779790
780791 - `"invalid_tool_input"`
from line 806
795806
796807 - `"unavailable"`
797808
798 - `type: "web_fetch_tool_result_error"`
809 - `"content_too_large"`
799810
800811 - `WebFetchBlockParam object`
801812
813 - `type: "web_fetch_result"`
814
802815 - `content: DocumentBlockParam`
803816
804 - `type: "web_fetch_result"`
805
806817 - `url: string`
807818
808819 Fetched content URL
from line 826
815826
816827 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
817828
818 - `type: "web_fetch_tool_result"`
819
820829 - `cache_control: optional CacheControlEphemeral or null`
821830
822831 Create a cache control breakpoint at this content block.
from line 846
837846
838847 - `CodeExecutionToolResultBlockParam object`
839848
849 - `type: "code_execution_tool_result"`
850
840851 - `content: CodeExecutionToolResultBlockParamContent`
841852
842853 Code execution result with encrypted stdout for PFC + web_search results.
843854
844855 - `CodeExecutionToolResultErrorParam object`
845856
857 - `type: "code_execution_tool_result_error"`
858
846859 - `error_code: CodeExecutionToolResultErrorCode`
847860
848861 - `"invalid_tool_input"`
from line 866
853866
854867 - `"execution_time_exceeded"`
855868
856 - `type: "code_execution_tool_result_error"`
857
858869 - `CodeExecutionResultBlockParam object`
859870
871 - `type: "code_execution_result"`
872
860873 - `content: array of CodeExecutionOutputBlockParam`
861874
875 - `type: "code_execution_output"`
876
862877 - `file_id: string`
863878
879 - `return_code: number`
880
881 - `stderr: string`
882
883 - `stdout: string`
884
885 - `EncryptedCodeExecutionResultBlockParam object`
886
887 Code execution result with encrypted stdout for PFC + web_search results.
888
889 - `type: "encrypted_code_execution_result"`
890
891 - `content: array of CodeExecutionOutputBlockParam`
892
864893 - `type: "code_execution_output"`
865894
895 - `file_id: string`
896
897 - `encrypted_stdout: string`
898
866899 - `return_code: number`
867900
868901 - `stderr: string`
869902
903 - `tool_use_id: string`
904
905 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
906
907 - `cache_control: optional CacheControlEphemeral or null`
908
909 Create a cache control breakpoint at this content block.
910
911 - `BashCodeExecutionToolResultBlockParam object`
912
913 - `type: "bash_code_execution_tool_result"`
914
915 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
916
917 - `BashCodeExecutionToolResultErrorParam object`
918
919 - `type: "bash_code_execution_tool_result_error"`
920
921 - `error_code: BashCodeExecutionToolResultErrorCode`
922
923 - `"invalid_tool_input"`
924
925 - `"unavailable"`
926
927 - `"too_many_requests"`
928
929 - `"execution_time_exceeded"`
930
931 - `"output_file_too_large"`
932
933 - `BashCodeExecutionResultBlockParam object`
934
935 - `type: "bash_code_execution_result"`
936
937 - `content: array of BashCodeExecutionOutputBlockParam`
938
939 - `type: "bash_code_execution_output"`
940
941 - `file_id: string`
942
943 - `return_code: number`
944
945 - `stderr: string`
946
870947 - `stdout: string`
871948
872 - `type: "code_execution_result"`
873
874 - `EncryptedCodeExecutionResultBlockParam object`
875
876 Code execution result with encrypted stdout for PFC + web_search results.
877
878 - `content: array of CodeExecutionOutputBlockParam`
879
880 - `file_id: string`
881
882 - `type: "code_execution_output"`
883
884 - `encrypted_stdout: string`
885
886 - `return_code: number`
887
888 - `stderr: string`
889
890 - `type: "encrypted_code_execution_result"`
891
892949 - `tool_use_id: string`
893950
894951 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
895952
896 - `type: "code_execution_tool_result"`
897
898953 - `cache_control: optional CacheControlEphemeral or null`
899954
900955 Create a cache control breakpoint at this content block.
901956
902 - `BashCodeExecutionToolResultBlockParam object`
903
904 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
905
906 - `BashCodeExecutionToolResultErrorParam object`
907
908 - `error_code: BashCodeExecutionToolResultErrorCode`
957 - `TextEditorCodeExecutionToolResultBlockParam object`
958
959 - `type: "text_editor_code_execution_tool_result"`
960
961 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
962
963 - `TextEditorCodeExecutionToolResultErrorParam object`
964
965 - `type: "text_editor_code_execution_tool_result_error"`
966
967 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
909968
910969 - `"invalid_tool_input"`
911970
from line 974
915974
916975 - `"execution_time_exceeded"`
917976
918 - `"output_file_too_large"`
919
920 - `type: "bash_code_execution_tool_result_error"`
921
922 - `BashCodeExecutionResultBlockParam object`
923
924 - `content: array of BashCodeExecutionOutputBlockParam`
925
926 - `file_id: string`
927
928 - `type: "bash_code_execution_output"`
929
930 - `return_code: number`
931
932 - `stderr: string`
933
934 - `stdout: string`
935
936 - `type: "bash_code_execution_result"`
977 - `"file_not_found"`
978
979 - `error_message: optional string or null`
980
981 - `TextEditorCodeExecutionViewResultBlockParam object`
982
983 - `type: "text_editor_code_execution_view_result"`
984
985 - `content: string`
986
987 - `file_type: "text" or "image" or "pdf"`
988
989 - `"text"`
990
991 - `"image"`
992
993 - `"pdf"`
994
995 - `num_lines: optional number or null`
996
997 - `start_line: optional number or null`
998
999 - `total_lines: optional number or null`
1000
1001 - `TextEditorCodeExecutionCreateResultBlockParam object`
1002
1003 - `type: "text_editor_code_execution_create_result"`
1004
1005 - `is_file_update: boolean`
1006
1007 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
1008
1009 - `type: "text_editor_code_execution_str_replace_result"`
1010
1011 - `lines: optional array of string or null`
1012
1013 - `new_lines: optional number or null`
1014
1015 - `new_start: optional number or null`
1016
1017 - `old_lines: optional number or null`
1018
1019 - `old_start: optional number or null`
9371020
9381021 - `tool_use_id: string`
9391022
9401023 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
9411024
942 - `type: "bash_code_execution_tool_result"`
943
9441025 - `cache_control: optional CacheControlEphemeral or null`
9451026
9461027 Create a cache control breakpoint at this content block.
9471028
948 - `TextEditorCodeExecutionToolResultBlockParam object`
949
950 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
951
952 - `TextEditorCodeExecutionToolResultErrorParam object`
953
954 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
1029 - `ToolSearchToolResultBlockParam object`
1030
1031 - `type: "tool_search_tool_result"`
1032
1033 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1034
1035 - `ToolSearchToolResultErrorParam object`
1036
1037 - `type: "tool_search_tool_result_error"`
1038
1039 - `error_code: ToolSearchToolResultErrorCode`
9551040
9561041 - `"invalid_tool_input"`
9571042
from line 1046
9611046
9621047 - `"execution_time_exceeded"`
9631048
964 - `"file_not_found"`
965
966 - `type: "text_editor_code_execution_tool_result_error"`
967
9681049 - `error_message: optional string or null`
9691050
970 - `TextEditorCodeExecutionViewResultBlockParam object`
971
972 - `content: string`
973
974 - `file_type: "text" or "image" or "pdf"`
975
976 - `"text"`
977
978 - `"image"`
979
980 - `"pdf"`
981
982 - `type: "text_editor_code_execution_view_result"`
983
984 - `num_lines: optional number or null`
985
986 - `start_line: optional number or null`
987
988 - `total_lines: optional number or null`
989
990 - `TextEditorCodeExecutionCreateResultBlockParam object`
991
992 - `is_file_update: boolean`
993
994 - `type: "text_editor_code_execution_create_result"`
995
996 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
997
998 - `type: "text_editor_code_execution_str_replace_result"`
999
1000 - `lines: optional array of string or null`
1001
1002 - `new_lines: optional number or null`
1003
1004 - `new_start: optional number or null`
1005
1006 - `old_lines: optional number or null`
1007
1008 - `old_start: optional number or null`
1051 - `ToolSearchToolSearchResultBlockParam object`
1052
1053 - `type: "tool_search_tool_search_result"`
1054
1055 - `tool_references: array of ToolReferenceBlockParam`
1056
1057 - `type: "tool_reference"`
1058
1059 - `tool_name: string`
1060
1061 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1062
1063 - `cache_control: optional CacheControlEphemeral or null`
1064
1065 Create a cache control breakpoint at this content block.
10091066
10101067 - `tool_use_id: string`
10111068
10121069 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
1013
1014 - `type: "text_editor_code_execution_tool_result"`
1015
1016 - `cache_control: optional CacheControlEphemeral or null`
1017
1018 Create a cache control breakpoint at this content block.
1019
1020 - `ToolSearchToolResultBlockParam object`
1021
1022 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1023
1024 - `ToolSearchToolResultErrorParam object`
1025
1026 - `error_code: ToolSearchToolResultErrorCode`
1027
1028 - `"invalid_tool_input"`
1029
1030 - `"unavailable"`
1031
1032 - `"too_many_requests"`
1033
1034 - `"execution_time_exceeded"`
1035
1036 - `type: "tool_search_tool_result_error"`
1037
1038 - `error_message: optional string or null`
1039
1040 - `ToolSearchToolSearchResultBlockParam object`
1041
1042 - `tool_references: array of ToolReferenceBlockParam`
1043
1044 - `tool_name: string`
1045
1046 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1047
1048 - `type: "tool_reference"`
1049
1050 - `cache_control: optional CacheControlEphemeral or null`
1051
1052 Create a cache control breakpoint at this content block.
1053
1054 - `type: "tool_search_tool_search_result"`
1055
1056 - `tool_use_id: string`
1057
1058 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
1059
1060 - `type: "tool_search_tool_result"`
10611070
10621071 - `cache_control: optional CacheControlEphemeral or null`
10631072
from line 1077
10681077 A content block that represents a file to be uploaded to the container
10691078 Files uploaded via this block will be available in the container's input directory.
10701079
1080 - `type: "container_upload"`
1081
10711082 - `file_id: string`
10721083
1073 - `type: "container_upload"`
1074
10751084 - `cache_control: optional CacheControlEphemeral or null`
10761085
10771086 Create a cache control breakpoint at this content block.
from line 1197
11881197
11891198 maxItems: 20
11901199
1200 - `type: "anthropic" or "custom"`
1201
1202 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1203
1204 - `"anthropic"`
1205
1206 - `"custom"`
1207
11911208 - `skill_id: string`
11921209
11931210 Skill ID
11941211
11951212 maxLength: 64, minLength: 1
11961213
1197 - `type: "anthropic" or "custom"`
1198
1199 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1200
1201 - `"anthropic"`
1202
1203 - `"custom"`
1204
12051214 - `version: optional string`
12061215
12071216 Skill version or 'latest' for most recent version
from line 1257
12481257
12491258 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
12501259
1260 - `type: "json_schema"`
1261
12511262 - `schema: map[unknown]`
12521263
12531264 The JSON schema of the format
12541265
1255 - `type: "json_schema"`
1256
12571266 - `service_tier: optional "auto" or "standard_only"`
12581267
12591268 Determines whether to use priority capacity (if available) or standard capacity for this request.
from line 1297
12881297
12891298 - `array of TextBlockParam`
12901299
1300 - `type: "text"`
1301
12911302 - `text: string`
12921303
12931304 minLength: 1
12941305
1295 - `type: "text"`
1296
12971306 - `cache_control: optional CacheControlEphemeral or null`
12981307
12991308 Create a cache control breakpoint at this content block.
from line 1319
13101319
13111320 - `ThinkingConfigEnabled object`
13121321
1322 - `type: "enabled"`
1323
13131324 - `budget_tokens: number`
13141325
13151326 Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
from line 1331
13201331
13211332 minimum: 1024
13221333
1323 - `type: "enabled"`
1324
13251334 - `display: optional "summarized" or "omitted" or null`
13261335
13271336 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1387
13781387
13791388 The model will use the specified tool with `tool_choice.name`.
13801389
1390 - `type: "tool"`
1391
13811392 - `name: string`
13821393
13831394 The name of the tool to use.
1384
1385 - `type: "tool"`
13861395
13871396 - `disable_parallel_tool_use: optional boolean`
13881397
from line 1471
14621471
14631472 - `Tool object`
14641473
1474 - `type: optional "custom" or null`
1475
14651476 - `input_schema: object`
14661477
14671478 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
from line 1527
15161527
15171528 When true, guarantees schema validation on tool names and inputs
15181529
1519 - `type: optional "custom" or null`
1520
15211530 - `ToolBash20250124 object`
15221531
1532 - `type: "bash_20250124"`
1533
15231534 - `name: "bash"`
15241535
15251536 Name of the tool.
15261537
15271538 This is how the tool will be called by the model and in `tool_use` blocks.
15281539
1529 - `type: "bash_20250124"`
1530
15311540 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15321541
15331542 - `"direct"`
from line 1563
15541563
15551564 - `CodeExecutionTool20250522 object`
15561565
1566 - `type: "code_execution_20250522"`
1567
15571568 - `name: "code_execution"`
15581569
15591570 Name of the tool.
15601571
15611572 This is how the tool will be called by the model and in `tool_use` blocks.
15621573
1563 - `type: "code_execution_20250522"`
1564
15651574 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15661575
15671576 - `"direct"`
from line 1595
15861595
15871596 - `CodeExecutionTool20250825 object`
15881597
1598 - `type: "code_execution_20250825"`
1599
15891600 - `name: "code_execution"`
15901601
15911602 Name of the tool.
15921603
15931604 This is how the tool will be called by the model and in `tool_use` blocks.
15941605
1595 - `type: "code_execution_20250825"`
1596
15971606 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15981607
15991608 - `"direct"`
from line 1629
16201629
16211630 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
16221631
1632 - `type: "code_execution_20260120"`
1633
16231634 - `name: "code_execution"`
16241635
16251636 Name of the tool.
16261637
16271638 This is how the tool will be called by the model and in `tool_use` blocks.
16281639
1629 - `type: "code_execution_20260120"`
1630
16311640 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16321641
16331642 - `"direct"`
from line 1663
16541663
16551664 Code execution tool with REPL state persistence.
16561665
1666 - `type: "code_execution_20260521"`
1667
16571668 - `name: "code_execution"`
16581669
16591670 Name of the tool.
16601671
16611672 This is how the tool will be called by the model and in `tool_use` blocks.
1662
1663 - `type: "code_execution_20260521"`
16641673
16651674 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16661675
from line 1715
17061715 absent. Unknown keys are rejected: the field set is this toolset
17071716 version's complete member set.
17081717
1718 - `type: optional BrowserTypeConfig or null`
1719
1720 `type`'s config overrides.
1721
1722 - `defer_loading: optional boolean or null`
1723
1724 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1725
1726 - `enabled: optional boolean or null`
1727
1728 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
1729
17091730 - `close_tab: optional BrowserCloseTabConfig or null`
17101731
17111732 `close_tab`'s config overrides.
from line 2063
20422063
20432064 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
20442065
2045 - `type: optional BrowserTypeConfig or null`
2046
2047 `type`'s config overrides.
2048
2049 - `defer_loading: optional boolean or null`
2050
2051 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2052
2053 - `enabled: optional boolean or null`
2054
2055 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2056
20572066 - `wait: optional BrowserWaitConfig or null`
20582067
20592068 `wait`'s config overrides.
from line 2089
20802089
20812090 - `MemoryTool20250818 object`
20822091
2092 - `type: "memory_20250818"`
2093
20832094 - `name: "memory"`
20842095
20852096 Name of the tool.
20862097
20872098 This is how the tool will be called by the model and in `tool_use` blocks.
2088
2089 - `type: "memory_20250818"`
20902099
20912100 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
20922101
from line 2147
21382147 absent. Unknown keys are rejected: the field set is this toolset
21392148 version's complete member set.
21402149
2150 - `type: optional ComputerTypeConfig or null`
2151
2152 `type`'s config overrides.
2153
2154 - `defer_loading: optional boolean or null`
2155
2156 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2157
2158 - `enabled: optional boolean or null`
2159
2160 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2161
21412162 - `cursor_position: optional ComputerCursorPositionConfig or null`
21422163
21432164 `cursor_position`'s config overrides.
from line 2327
23062327
23072328 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
23082329
2309 - `type: optional ComputerTypeConfig or null`
2310
2311 `type`'s config overrides.
2312
2313 - `defer_loading: optional boolean or null`
2314
2315 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2316
2317 - `enabled: optional boolean or null`
2318
2319 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2320
23212330 - `wait: optional ComputerWaitConfig or null`
23222331
23232332 `wait`'s config overrides.
from line 2353
23442353
23452354 - `ToolTextEditor20250124 object`
23462355
2356 - `type: "text_editor_20250124"`
2357
23472358 - `name: "str_replace_editor"`
23482359
23492360 Name of the tool.
23502361
23512362 This is how the tool will be called by the model and in `tool_use` blocks.
23522363
2353 - `type: "text_editor_20250124"`
2354
23552364 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23562365
23572366 - `"direct"`
from line 2387
23782387
23792388 - `ToolTextEditor20250429 object`
23802389
2390 - `type: "text_editor_20250429"`
2391
23812392 - `name: "str_replace_based_edit_tool"`
23822393
23832394 Name of the tool.
23842395
23852396 This is how the tool will be called by the model and in `tool_use` blocks.
23862397
2387 - `type: "text_editor_20250429"`
2388
23892398 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23902399
23912400 - `"direct"`
from line 2421
24122421
24132422 - `ToolTextEditor20250728 object`
24142423
2424 - `type: "text_editor_20250728"`
2425
24152426 - `name: "str_replace_based_edit_tool"`
24162427
24172428 Name of the tool.
24182429
24192430 This is how the tool will be called by the model and in `tool_use` blocks.
24202431
2421 - `type: "text_editor_20250728"`
2422
24232432 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24242433
24252434 - `"direct"`
from line 2461
24522461
24532462 - `WebSearchTool20250305 object`
24542463
2464 - `type: "web_search_20250305"`
2465
24552466 - `name: "web_search"`
24562467
24572468 Name of the tool.
24582469
24592470 This is how the tool will be called by the model and in `tool_use` blocks.
24602471
2461 - `type: "web_search_20250305"`
2462
24632472 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24642473
24652474 - `"direct"`
from line 2537
25282537
25292538 - `WebFetchTool20250910 object`
25302539
2540 - `type: "web_fetch_20250910"`
2541
25312542 - `name: "web_fetch"`
25322543
25332544 Name of the tool.
25342545
25352546 This is how the tool will be called by the model and in `tool_use` blocks.
25362547
2537 - `type: "web_fetch_20250910"`
2538
25392548 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25402549
25412550 - `"direct"`
from line 2593
25842593
25852594 - `WebSearchTool20260209 object`
25862595
2596 - `type: "web_search_20260209"`
2597
25872598 - `name: "web_search"`
25882599
25892600 Name of the tool.
25902601
25912602 This is how the tool will be called by the model and in `tool_use` blocks.
25922603
2593 - `type: "web_search_20260209"`
2594
25952604 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25962605
25972606 - `"direct"`
from line 2643
26342643
26352644 - `WebFetchTool20260209 object`
26362645
2646 - `type: "web_fetch_20260209"`
2647
26372648 - `name: "web_fetch"`
26382649
26392650 Name of the tool.
26402651
26412652 This is how the tool will be called by the model and in `tool_use` blocks.
26422653
2643 - `type: "web_fetch_20260209"`
2644
26452654 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
26462655
26472656 - `"direct"`
from line 2701
26922701
26932702 Web fetch tool with use_cache parameter for bypassing cached content.
26942703
2704 - `type: "web_fetch_20260309"`
2705
26952706 - `name: "web_fetch"`
26962707
26972708 Name of the tool.
26982709
26992710 This is how the tool will be called by the model and in `tool_use` blocks.
27002711
2701 - `type: "web_fetch_20260309"`
2702
27032712 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27042713
27052714 - `"direct"`
from line 2761
27522761
27532762 - `WebSearchTool20260318 object`
27542763
2764 - `type: "web_search_20260318"`
2765
27552766 - `name: "web_search"`
27562767
27572768 Name of the tool.
27582769
27592770 This is how the tool will be called by the model and in `tool_use` blocks.
27602771
2761 - `type: "web_search_20260318"`
2762
27632772 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27642773
27652774 - `"direct"`
from line 2819
28102819
28112820 - `WebFetchTool20260318 object`
28122821
2822 - `type: "web_fetch_20260318"`
2823
28132824 - `name: "web_fetch"`
28142825
28152826 Name of the tool.
28162827
28172828 This is how the tool will be called by the model and in `tool_use` blocks.
28182829
2819 - `type: "web_fetch_20260318"`
2820
28212830 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28222831
28232832 - `"direct"`
from line 2887
28782887
28792888 - `ToolSearchToolBm25_20251119 object`
28802889
2890 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2891
2892 - `"tool_search_tool_bm25_20251119"`
2893
2894 - `"tool_search_tool_bm25"`
2895
28812896 - `name: "tool_search_tool_bm25"`
28822897
28832898 Name of the tool.
28842899
28852900 This is how the tool will be called by the model and in `tool_use` blocks.
28862901
2887 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2888
2889 - `"tool_search_tool_bm25_20251119"`
2890
2891 - `"tool_search_tool_bm25"`
2892
28932902 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28942903
28952904 - `"direct"`
from line 2923
29142923
29152924 - `ToolSearchToolRegex20251119 object`
29162925
2926 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2927
2928 - `"tool_search_tool_regex_20251119"`
2929
2930 - `"tool_search_tool_regex"`
2931
29172932 - `name: "tool_search_tool_regex"`
29182933
29192934 Name of the tool.
29202935
29212936 This is how the tool will be called by the model and in `tool_use` blocks.
29222937
2923 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2924
2925 - `"tool_search_tool_regex_20251119"`
2926
2927 - `"tool_search_tool_regex"`
2928
29292938 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
29302939
29312940 - `"direct"`
from line 2997
29882997
29892998- `MessageBatch object`
29902999
3000 - `type: "message_batch"`
3001
3002 Object type.
3003
3004 For Message Batches, this is always `"message_batch"`.
3005
3006 default: message_batch
3007
29913008 - `id: string`
29923009
29933010 Unique object identifier.
from line 3102
30853102 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
30863103
30873104 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
3088
3089 - `type: "message_batch"`
3090
3091 Object type.
3092
3093 For Message Batches, this is always `"message_batch"`.
3094
3095 default: message_batch
30963105
30973106## Example
30983107
30993108
api/messages/batches/delete Changed · +13 / -4 lines
## Headers
from line 1
1---
2title: Delete a Message Batch
3url: https://platform.claude.com/docs/en/api/messages/batches/delete
4---
5
16# Delete a Message Batch
27
38**DELETE** `/v1/messages/batches/{message_batch_id}`
from line 19
1419
1520 ID of the Message Batch.
1621
22## Headers
23
24- `"anthropic-workspace-id": optional string`
25
1726## Returns
1827
1928- `DeletedMessageBatch object`
2029
21 - `id: string`
22
23 ID of the Message Batch.
24
2530 - `type: "message_batch_deleted"`
2631
2732 Deleted object type.
from line 34
2934 For Message Batches, this is always `"message_batch_deleted"`.
3035
3136 default: message_batch_deleted
37
38 - `id: string`
39
40 ID of the Message Batch.
3241
3342## Example
3443
api/messages/batches/list Changed · +17 / -8 lines
## Headers
from line 1
1---
2title: List Message Batches
3url: https://platform.claude.com/docs/en/api/messages/batches/list
4---
5
16# List Message Batches
27
38**GET** `/v1/messages/batches`
from line 29
2429
2530 default: 20, maximum: 1000, minimum: 1
2631
32## Headers
33
34- `"anthropic-workspace-id": optional string`
35
2736## Returns
2837
2938- `data: array of MessageBatch`
3039
40 - `type: "message_batch"`
41
42 Object type.
43
44 For Message Batches, this is always `"message_batch"`.
45
46 default: message_batch
47
3148 - `id: string`
3249
3350 Unique object identifier.
from line 142
125142 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
126143
127144 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
128
129 - `type: "message_batch"`
130
131 Object type.
132
133 For Message Batches, this is always `"message_batch"`.
134
135 default: message_batch
136145
137146- `first_id: string or null`
138147
api/messages/batches/results Changed · +337 / -326 lines
## Headers
from line 1
1---
2title: Retrieve Message Batch results
3url: https://platform.claude.com/docs/en/api/messages/batches/results
4---
5
16# Retrieve Message Batch results
27
38**GET** `/v1/messages/batches/{message_batch_id}/results`
from line 19
1419
1520 ID of the Message Batch.
1621
22## Headers
23
24- `"anthropic-workspace-id": optional string`
25
1726## Returns
1827
1928- `MessageBatchIndividualResponse object`
from line 43
3443
3544 - `MessageBatchSucceededResult object`
3645
46 - `type: "succeeded"`
47
48 default: succeeded
49
3750 - `message: Message`
3851
52 - `type: "message"`
53
54 Object type.
55
56 For Messages, this is always `"message"`.
57
58 default: message
59
3960 - `id: string`
4061
4162 Unique object identifier.
from line 81
6081
6182 Skills loaded in the container
6283
63 - `skill_id: string`
64
65 Skill ID
66
67 maxLength: 64, minLength: 1
68
6984 - `type: "anthropic" or "custom"`
7085
7186 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
from line 89
7489
7590 - `"custom"`
7691
92 - `skill_id: string`
93
94 Skill ID
95
96 maxLength: 64, minLength: 1
97
7798 - `version: string`
7899
79100 The resolved version: a skill version ID for custom skills.
from line 132
111132
112133 - `TextBlock object`
113134
135 - `type: "text"`
136
137 default: text
138
114139 - `citations: array of TextCitation or null`
115140
116141 Citations supporting the text block.
from line 144
119144
120145 - `CitationCharLocation object`
121146
147 - `type: "char_location"`
148
149 default: char_location
150
122151 - `cited_text: string`
123152
124153 - `document_index: number`
from line 164
135164
136165 minimum: 0
137166
138 - `type: "char_location"`
167 - `CitationPageLocation object`
139168
140 default: char_location
169 - `type: "page_location"`
141170
142 - `CitationPageLocation object`
171 default: page_location
143172
144173 - `cited_text: string`
145174
from line 186
157186
158187 minimum: 1
159188
160 - `type: "page_location"`
189 - `CitationContentBlockLocation object`
161190
162 default: page_location
191 - `type: "content_block_location"`
163192
164 - `CitationContentBlockLocation object`
193 default: content_block_location
165194
166195 - `cited_text: string`
167196
from line 218
189218
190219 minimum: 0
191220
192 - `type: "content_block_location"`
221 - `CitationsWebSearchResultLocation object`
193222
194 default: content_block_location
223 - `type: "web_search_result_location"`
195224
196 - `CitationsWebSearchResultLocation object`
225 default: web_search_result_location
197226
198227 - `cited_text: string`
199228
from line 232
203232
204233 maxLength: 512
205234
206 - `type: "web_search_result_location"`
207
208 default: web_search_result_location
209
210235 - `url: string`
211236
212237 - `CitationsSearchResultLocation object`
213238
239 - `type: "search_result_location"`
240
241 default: search_result_location
242
214243 - `cited_text: string`
215244
216245 The full text of the cited block range, concatenated.
from line 270
241270
242271 - `title: string or null`
243272
244 - `type: "search_result_location"`
245
246 default: search_result_location
247
248273 - `text: string`
249274
250 maxLength: 5000000, minLength: 0
275 minLength: 0
251276
252 - `type: "text"`
277 - `ThinkingBlock object`
253278
254 default: text
279 - `type: "thinking"`
255280
256 - `ThinkingBlock object`
281 default: thinking
257282
258283 - `signature: string`
259284
from line 292
267292
268293 The text of Claude's thinking process for this block.
269294
270 - `type: "thinking"`
295 - `RedactedThinkingBlock object`
271296
272 default: thinking
297 - `type: "redacted_thinking"`
273298
274 - `RedactedThinkingBlock object`
299 default: redacted_thinking
275300
276301 - `data: string`
277302
from line 306
281306
282307 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
283308
284 - `type: "redacted_thinking"`
309 - `ToolUseBlock object`
285310
286 default: redacted_thinking
311 - `type: "tool_use"`
287312
288 - `ToolUseBlock object`
313 default: tool_use
289314
290315 - `id: string`
291316
from line 332
307332
308333 Tool invocation generated by a server-side tool.
309334
335 - `type: "code_execution_20250825"`
336
310337 - `tool_id: string`
311338
312339 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
313340
314 - `type: "code_execution_20250825"`
315
316341 - `ServerToolCaller20260120 object`
317342
343 - `type: "code_execution_20260120"`
344
318345 - `tool_id: string`
319346
320347 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
321348
322 - `type: "code_execution_20260120"`
323
324349 - `input: map[unknown]`
325350
326351 - `name: string`
from line 352
327352
328353 minLength: 1
329354
330 - `type: "tool_use"`
331
332 default: tool_use
333
334355 - `toolset_name: optional string or null`
335356
336357 For a toolset member tool_use, the toolset family.
from line 360
339360
340361 - `ServerToolUseBlock object`
341362
363 - `type: "server_tool_use"`
364
365 default: server_tool_use
366
342367 - `id: string`
343368
344369 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 402
377402
378403 - `"tool_search_tool_bm25"`
379404
380 - `type: "server_tool_use"`
405 - `WebSearchToolResultBlock object`
381406
382 default: server_tool_use
407 - `type: "web_search_tool_result"`
383408
384 - `WebSearchToolResultBlock object`
409 default: web_search_tool_result
385410
386411 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
387412
from line 428
403428
404429 - `WebSearchToolResultError object`
405430
431 - `type: "web_search_tool_result_error"`
432
433 default: web_search_tool_result_error
434
406435 - `error_code: WebSearchToolResultErrorCode`
407436
408437 - `"invalid_tool_input"`
from line 446
417446
418447 - `"request_too_large"`
419448
420 - `type: "web_search_tool_result_error"`
449 - `array of WebSearchResultBlock`
421450
422 default: web_search_tool_result_error
451 - `type: "web_search_result"`
423452
424 - `array of WebSearchResultBlock`
453 default: web_search_result
425454
426455 - `encrypted_content: string`
427456
from line 458
429458
430459 - `title: string`
431460
432 - `type: "web_search_result"`
433
434 default: web_search_result
435
436461 - `url: string`
437462
438463 - `tool_use_id: string`
from line 464
439464
440465 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
441466
442 - `type: "web_search_tool_result"`
467 - `WebFetchToolResultBlock object`
443468
444 default: web_search_tool_result
469 - `type: "web_fetch_tool_result"`
445470
446 - `WebFetchToolResultBlock object`
471 default: web_fetch_tool_result
447472
448473 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
449474
from line 490
465490
466491 - `WebFetchToolResultErrorBlock object`
467492
493 - `type: "web_fetch_tool_result_error"`
494
495 default: web_fetch_tool_result_error
496
468497 - `error_code: WebFetchToolResultErrorCode`
469498
470499 - `"invalid_tool_input"`
from line 514
485514
486515 - `"unavailable"`
487516
488 - `type: "web_fetch_tool_result_error"`
517 - `"content_too_large"`
489518
490 default: web_fetch_tool_result_error
491
492519 - `WebFetchBlock object`
493520
521 - `type: "web_fetch_result"`
522
523 default: web_fetch_result
524
494525 - `content: DocumentBlock`
495526
527 - `type: "document"`
528
529 default: document
530
496531 - `citations: CitationsConfig or null`
497532
498533 Citation configuration for the document
from line 540
505540
506541 - `Base64PDFSource object`
507542
543 - `type: "base64"`
544
508545 - `data: string`
509546
510547 format: byte
from line 548
511548
512549 - `media_type: "application/pdf"`
513550
514 - `type: "base64"`
515
516551 - `PlainTextSource object`
517552
553 - `type: "text"`
554
518555 - `data: string`
519556
520557 - `media_type: "text/plain"`
521558
522 - `type: "text"`
523
524559 - `title: string or null`
525560
526561 The title of the document
527562
528 - `type: "document"`
529
530 default: document
531
532563 - `retrieved_at: string or null`
533564
534565 ISO 8601 timestamp when the content was retrieved
535566
536 - `type: "web_fetch_result"`
537
538 default: web_fetch_result
539
540567 - `url: string`
541568
542569 Fetched content URL
from line 572
545572
546573 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
547574
548 - `type: "web_fetch_tool_result"`
575 - `CodeExecutionToolResultBlock object`
549576
550 default: web_fetch_tool_result
577 - `type: "code_execution_tool_result"`
551578
552 - `CodeExecutionToolResultBlock object`
579 default: code_execution_tool_result
553580
554581 - `content: CodeExecutionToolResultBlockContent`
555582
from line 584
557584
558585 - `CodeExecutionToolResultError object`
559586
587 - `type: "code_execution_tool_result_error"`
588
589 default: code_execution_tool_result_error
590
560591 - `error_code: CodeExecutionToolResultErrorCode`
561592
562593 - `"invalid_tool_input"`
from line 598
567598
568599 - `"execution_time_exceeded"`
569600
570 - `type: "code_execution_tool_result_error"`
601 - `CodeExecutionResultBlock object`
571602
572 default: code_execution_tool_result_error
603 - `type: "code_execution_result"`
573604
574 - `CodeExecutionResultBlock object`
605 default: code_execution_result
575606
576607 - `content: array of CodeExecutionOutputBlock`
577608
578 - `file_id: string`
579
580609 - `type: "code_execution_output"`
581610
582611 default: code_execution_output
583612
613 - `file_id: string`
614
584615 - `return_code: number`
585616
586617 - `stderr: string`
from line 618
587618
588619 - `stdout: string`
589620
590 - `type: "code_execution_result"`
591
592 default: code_execution_result
593
594621 - `EncryptedCodeExecutionResultBlock object`
595622
596623 Code execution result with encrypted stdout for PFC + web_search results.
597624
598 - `content: array of CodeExecutionOutputBlock`
625 - `type: "encrypted_code_execution_result"`
599626
600 - `file_id: string`
627 default: encrypted_code_execution_result
601628
629 - `content: array of CodeExecutionOutputBlock`
630
602631 - `type: "code_execution_output"`
603632
604633 default: code_execution_output
605634
635 - `file_id: string`
636
606637 - `encrypted_stdout: string`
607638
608639 - `return_code: number`
from line 640
609640
610641 - `stderr: string`
611642
612 - `type: "encrypted_code_execution_result"`
613
614 default: encrypted_code_execution_result
615
616643 - `tool_use_id: string`
617644
618645 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
619646
620 - `type: "code_execution_tool_result"`
647 - `BashCodeExecutionToolResultBlock object`
621648
622 default: code_execution_tool_result
649 - `type: "bash_code_execution_tool_result"`
623650
624 - `BashCodeExecutionToolResultBlock object`
651 default: bash_code_execution_tool_result
625652
626653 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
627654
628655 - `BashCodeExecutionToolResultError object`
629656
657 - `type: "bash_code_execution_tool_result_error"`
658
659 default: bash_code_execution_tool_result_error
660
630661 - `error_code: BashCodeExecutionToolResultErrorCode`
631662
632663 - `"invalid_tool_input"`
from line 670
639670
640671 - `"output_file_too_large"`
641672
642 - `type: "bash_code_execution_tool_result_error"`
673 - `BashCodeExecutionResultBlock object`
643674
644 default: bash_code_execution_tool_result_error
675 - `type: "bash_code_execution_result"`
645676
646 - `BashCodeExecutionResultBlock object`
677 default: bash_code_execution_result
647678
648679 - `content: array of BashCodeExecutionOutputBlock`
649680
650 - `file_id: string`
651
652681 - `type: "bash_code_execution_output"`
653682
654683 default: bash_code_execution_output
655684
685 - `file_id: string`
686
656687 - `return_code: number`
657688
658689 - `stderr: string`
from line 690
659690
660691 - `stdout: string`
661692
662 - `type: "bash_code_execution_result"`
663
664 default: bash_code_execution_result
665
666693 - `tool_use_id: string`
667694
668695 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
669696
670 - `type: "bash_code_execution_tool_result"`
697 - `TextEditorCodeExecutionToolResultBlock object`
671698
672 default: bash_code_execution_tool_result
699 - `type: "text_editor_code_execution_tool_result"`
673700
674 - `TextEditorCodeExecutionToolResultBlock object`
701 default: text_editor_code_execution_tool_result
675702
676703 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
677704
678705 - `TextEditorCodeExecutionToolResultError object`
679706
707 - `type: "text_editor_code_execution_tool_result_error"`
708
709 default: text_editor_code_execution_tool_result_error
710
680711 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
681712
682713 - `"invalid_tool_input"`
from line 722
691722
692723 - `error_message: string or null`
693724
694 - `type: "text_editor_code_execution_tool_result_error"`
725 - `TextEditorCodeExecutionViewResultBlock object`
695726
696 default: text_editor_code_execution_tool_result_error
727 - `type: "text_editor_code_execution_view_result"`
697728
698 - `TextEditorCodeExecutionViewResultBlock object`
729 default: text_editor_code_execution_view_result
699730
700731 - `content: string`
701732
from line 744
713744
714745 - `total_lines: number or null`
715746
716 - `type: "text_editor_code_execution_view_result"`
717
718 default: text_editor_code_execution_view_result
719
720747 - `TextEditorCodeExecutionCreateResultBlock object`
721748
722 - `is_file_update: boolean`
723
724749 - `type: "text_editor_code_execution_create_result"`
725750
726751 default: text_editor_code_execution_create_result
727752
753 - `is_file_update: boolean`
754
728755 - `TextEditorCodeExecutionStrReplaceResultBlock object`
729756
757 - `type: "text_editor_code_execution_str_replace_result"`
758
759 default: text_editor_code_execution_str_replace_result
760
730761 - `lines: array of string or null`
731762
732763 - `new_lines: number or null`
from line 768
737768
738769 - `old_start: number or null`
739770
740 - `type: "text_editor_code_execution_str_replace_result"`
741
742 default: text_editor_code_execution_str_replace_result
743
744771 - `tool_use_id: string`
745772
746773 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
747774
748 - `type: "text_editor_code_execution_tool_result"`
775 - `ToolSearchToolResultBlock object`
749776
750 default: text_editor_code_execution_tool_result
777 - `type: "tool_search_tool_result"`
751778
752 - `ToolSearchToolResultBlock object`
779 default: tool_search_tool_result
753780
754781 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
755782
756783 - `ToolSearchToolResultError object`
757784
785 - `type: "tool_search_tool_result_error"`
786
787 default: tool_search_tool_result_error
788
758789 - `error_code: ToolSearchToolResultErrorCode`
759790
760791 - `"invalid_tool_input"`
from line 798
767798
768799 - `error_message: string or null`
769800
770 - `type: "tool_search_tool_result_error"`
801 - `ToolSearchToolSearchResultBlock object`
771802
772 default: tool_search_tool_result_error
803 - `type: "tool_search_tool_search_result"`
773804
774 - `ToolSearchToolSearchResultBlock object`
805 default: tool_search_tool_search_result
775806
776807 - `tool_references: array of ToolReferenceBlock`
777808
778 - `tool_name: string`
779
780 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
781
782809 - `type: "tool_reference"`
783810
784811 default: tool_reference
785812
786 - `type: "tool_search_tool_search_result"`
813 - `tool_name: string`
787814
788 default: tool_search_tool_search_result
815 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
789816
790817 - `tool_use_id: string`
791818
792819 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
793820
794 - `type: "tool_search_tool_result"`
795
796 default: tool_search_tool_result
797
798821 - `ContainerUploadBlock object`
799822
800823 Response model for a file uploaded to the container.
801824
802 - `file_id: string`
803
804825 - `type: "container_upload"`
805826
806827 default: container_upload
807828
829 - `file_id: string`
830
808831 - `model: Model`
809832
810833 The model that will complete your prompt.
from line 922
899922
900923 Structured information about a refusal.
901924
925 - `type: "refusal"`
926
927 default: refusal
928
902929 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
903930
904931 The policy category that triggered a refusal.
from line 956
929956
930957 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
931958
932 - `type: "refusal"`
933
934 default: refusal
935
936959 - `stop_reason: StopReason or null`
937960
938961 The reason that we stopped.
from line 992
969992
970993 This value will be a non-null string if one of your custom stop sequences was generated.
971994
972 - `type: "message"`
973
974 Object type.
975
976 For Messages, this is always `"message"`.
977
978 default: message
979
980995 - `usage: Usage`
981996
982997 Billing and rate-limit usage.
from line 1096
10811096
10821097 - `"batch"`
10831098
1084 - `type: "succeeded"`
1099 - `MessageBatchErroredResult object`
10851100
1086 default: succeeded
1101 - `type: "errored"`
10871102
1088 - `MessageBatchErroredResult object`
1103 default: errored
10891104
10901105 - `error: ErrorResponse`
10911106
1107 - `type: "error"`
1108
1109 default: error
1110
10921111 - `error: ErrorObject`
10931112
10941113 - `InvalidRequestError object`
10951114
1096 - `message: string`
1097
1098 default: Invalid request
1099
11001115 - `type: "invalid_request_error"`
11011116
11021117 default: invalid_request_error
11031118
1104 - `AuthenticationError object`
1105
11061119 - `message: string`
11071120
1108 default: Authentication error
1121 default: Invalid request
11091122
1123 - `AuthenticationError object`
1124
11101125 - `type: "authentication_error"`
11111126
11121127 default: authentication_error
11131128
1114 - `BillingError object`
1115
11161129 - `message: string`
11171130
1118 default: Billing error
1131 default: Authentication error
11191132
1133 - `BillingError object`
1134
11201135 - `type: "billing_error"`
11211136
11221137 default: billing_error
11231138
1124 - `PermissionError object`
1125
11261139 - `message: string`
11271140
1128 default: Permission denied
1141 default: Billing error
11291142
1143 - `PermissionError object`
1144
11301145 - `type: "permission_error"`
11311146
11321147 default: permission_error
11331148
1134 - `NotFoundError object`
1135
11361149 - `message: string`
11371150
1138 default: Not found
1151 default: Permission denied
11391152
1153 - `NotFoundError object`
1154
11401155 - `type: "not_found_error"`
11411156
11421157 default: not_found_error
11431158
1144 - `RateLimitError object`
1145
11461159 - `message: string`
11471160
1148 default: Rate limited
1161 default: Not found
11491162
1163 - `RateLimitError object`
1164
11501165 - `type: "rate_limit_error"`
11511166
11521167 default: rate_limit_error
11531168
1154 - `GatewayTimeoutError object`
1155
11561169 - `message: string`
11571170
1158 default: Request timeout
1171 default: Rate limited
11591172
1173 - `GatewayTimeoutError object`
1174
11601175 - `type: "timeout_error"`
11611176
11621177 default: timeout_error
11631178
1164 - `APIErrorObject object`
1165
11661179 - `message: string`
11671180
1168 default: Internal server error
1181 default: Request timeout
11691182
1183 - `APIErrorObject object`
1184
11701185 - `type: "api_error"`
11711186
11721187 default: api_error
11731188
1174 - `OverloadedError object`
1175
11761189 - `message: string`
11771190
1178 default: Overloaded
1191 default: Internal server error
11791192
1193 - `OverloadedError object`
1194
11801195 - `type: "overloaded_error"`
11811196
11821197 default: overloaded_error
11831198
1184 - `request_id: string or null`
1199 - `message: string`
11851200
1186 - `type: "error"`
1201 default: Overloaded
11871202
1188 default: error
1189
1190 - `type: "errored"`
1191
1192 default: errored
1203 - `request_id: string or null`
11931204
11941205 - `MessageBatchCanceledResult object`
11951206
api/messages/batches/retrieve Changed · +17 / -8 lines
## Headers
from line 1
1---
2title: Retrieve a Message Batch
3url: https://platform.claude.com/docs/en/api/messages/batches/retrieve
4---
5
16# Retrieve a Message Batch
27
38**GET** `/v1/messages/batches/{message_batch_id}`
from line 17
1217
1318 ID of the Message Batch.
1419
20## Headers
21
22- `"anthropic-workspace-id": optional string`
23
1524## Returns
1625
1726- `MessageBatch object`
1827
28 - `type: "message_batch"`
29
30 Object type.
31
32 For Message Batches, this is always `"message_batch"`.
33
34 default: message_batch
35
1936 - `id: string`
2037
2138 Unique object identifier.
from line 130
113130 URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends.
114131
115132 Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
116
117 - `type: "message_batch"`
118
119 Object type.
120
121 For Message Batches, this is always `"message_batch"`.
122
123 default: message_batch
124133
125134## Example
126135
api/messages/count_tokens Changed · +457 / -448 lines
from line 1
1---
2title: Count tokens in a Message
3url: https://platform.claude.com/docs/en/api/messages/count_tokens
4---
5
16# Count tokens in a Message
27
38**POST** `/v1/messages/count_tokens`
from line 19
1419
1520 The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header.
1621
22- `"anthropic-workspace-id": optional string`
23
1724## Body parameters
1825
1926- `messages: array of MessageParam`
from line 82
7582
7683 - `TextBlockParam object`
7784
85 - `type: "text"`
86
7887 - `text: string`
7988
8089 minLength: 1
8190
82 - `type: "text"`
83
8491 - `cache_control: optional CacheControlEphemeral or null`
8592
8693 Create a cache control breakpoint at this content block.
from line 113
106113
107114 - `CitationCharLocationParam object`
108115
116 - `type: "char_location"`
117
109118 - `cited_text: string`
110119
111120 - `document_index: number`
from line 131
122131
123132 minimum: 0
124133
125 - `type: "char_location"`
126
127134 - `CitationPageLocationParam object`
128135
136 - `type: "page_location"`
137
129138 - `cited_text: string`
130139
131140 - `document_index: number`
from line 151
142151
143152 minimum: 1
144153
145 - `type: "page_location"`
146
147154 - `CitationContentBlockLocationParam object`
148155
156 - `type: "content_block_location"`
157
149158 - `cited_text: string`
150159
151160 The full text of the cited block range, concatenated.
from line 181
172181
173182 minimum: 0
174183
175 - `type: "content_block_location"`
176
177184 - `CitationWebSearchResultLocationParam object`
178185
186 - `type: "web_search_result_location"`
187
179188 - `cited_text: string`
180189
181190 - `encrypted_index: string`
from line 193
184193
185194 maxLength: 512, minLength: 1
186195
187 - `type: "web_search_result_location"`
188
189196 - `url: string`
190197
191198 minLength: 1
from line 199
192199
193200 - `CitationSearchResultLocationParam object`
194201
202 - `type: "search_result_location"`
203
195204 - `cited_text: string`
196205
197206 The full text of the cited block range, concatenated.
from line 231
222231
223232 - `title: string or null`
224233
225 - `type: "search_result_location"`
226
227234 - `ImageBlockParam object`
228235
236 - `type: "image"`
237
229238 - `source: Base64ImageSource or URLImageSource or FileImageSource`
230239
231240 - `Base64ImageSource object`
232241
242 - `type: "base64"`
243
233244 - `data: string`
234245
235246 format: byte
from line 255
244255
245256 - `"image/webp"`
246257
247 - `type: "base64"`
248
249258 - `URLImageSource object`
250259
251260 - `type: "url"`
from line 263
254263
255264 - `FileImageSource object`
256265
257 - `file_id: string`
258
259266 - `type: "file"`
260267
261 - `type: "image"`
268 - `file_id: string`
262269
263270 - `cache_control: optional CacheControlEphemeral or null`
264271
from line 285
278285
279286 - `DocumentBlockParam object`
280287
288 - `type: "document"`
289
281290 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
282291
283292 - `Base64PDFSource object`
284293
294 - `type: "base64"`
295
285296 - `data: string`
286297
287298 format: byte
from line 299
288299
289300 - `media_type: "application/pdf"`
290301
291 - `type: "base64"`
292
293302 - `PlainTextSource object`
294303
304 - `type: "text"`
305
295306 - `data: string`
296307
297308 - `media_type: "text/plain"`
298309
299 - `type: "text"`
300
301310 - `ContentBlockSource object`
302311
312 - `type: "content"`
313
303314 - `content: string or array of ContentBlockSourceContent`
304315
305316 - `string`
from line 321
310321
311322 - `ImageBlockParam object`
312323
313 - `type: "content"`
314
315324 - `URLPDFSource object`
316325
317326 - `type: "url"`
from line 329
320329
321330 - `FileDocumentSource object`
322331
323 - `file_id: string`
324
325332 - `type: "file"`
326333
327 - `type: "document"`
334 - `file_id: string`
328335
329336 - `cache_control: optional CacheControlEphemeral or null`
330337
from line 351
344351
345352 - `SearchResultBlockParam object`
346353
354 - `type: "search_result"`
355
347356 - `content: array of TextBlockParam`
348357
358 - `type: "text"`
359
349360 - `text: string`
350361
351362 minLength: 1
352363
353 - `type: "text"`
354
355364 - `cache_control: optional CacheControlEphemeral or null`
356365
357366 Create a cache control breakpoint at this content block.
from line 371
362371
363372 - `title: string`
364373
365 - `type: "search_result"`
366
367374 - `cache_control: optional CacheControlEphemeral or null`
368375
369376 Create a cache control breakpoint at this content block.
from line 379
372379
373380 - `ThinkingBlockParam object`
374381
382 - `type: "thinking"`
383
375384 - `signature: string`
376385
377386 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
from line 391
382391
383392 The `thinking` text of this block as returned by the API.
384393
385 - `type: "thinking"`
386
387394 - `RedactedThinkingBlockParam object`
388395
396 - `type: "redacted_thinking"`
397
389398 - `data: string`
390399
391400 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
392401
393 - `type: "redacted_thinking"`
394
395402 - `ToolUseBlockParam object`
396403
404 - `type: "tool_use"`
405
397406 - `id: string`
398407
399408 pattern: ^[a-zA-Z0-9_-]+$
from line 413
404413
405414 maxLength: 200, minLength: 1
406415
407 - `type: "tool_use"`
408
409416 - `cache_control: optional CacheControlEphemeral or null`
410417
411418 Create a cache control breakpoint at this content block.
from line 431
424431
425432 Tool invocation generated by a server-side tool.
426433
434 - `type: "code_execution_20250825"`
435
427436 - `tool_id: string`
428437
429438 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
430439
431 - `type: "code_execution_20250825"`
432
433440 - `ServerToolCaller20260120 object`
434441
442 - `type: "code_execution_20260120"`
443
435444 - `tool_id: string`
436445
437446 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
438447
439 - `type: "code_execution_20260120"`
440
441448 - `toolset_name: optional string or null`
442449
443450 For a toolset member tool_use, the toolset family this member belongs to.
from line 453
446453
447454 - `ToolResultBlockParam object`
448455
456 - `type: "tool_result"`
457
449458 - `tool_use_id: string`
450459
451460 pattern: ^[a-zA-Z0-9_-]+$
452461
453 - `type: "tool_result"`
454
455462 - `cache_control: optional CacheControlEphemeral or null`
456463
457464 Create a cache control breakpoint at this content block.
from line 481
474481
475482 Tool reference block that can be included in tool_result content.
476483
484 - `type: "tool_reference"`
485
477486 - `tool_name: string`
478487
479488 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
480489
481 - `type: "tool_reference"`
482
483490 - `cache_control: optional CacheControlEphemeral or null`
484491
485492 Create a cache control breakpoint at this content block.
from line 501
494501 browser toolset member `tool_use`. The server renders the
495502 model-visible text from it; the model never sees the raw fields.
496503
504 - `type: "browser_state"`
505
497506 - `tabs: array of BrowserStateTabEntry`
498507
499508 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
from line 531
522531
523532 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
524533
525 - `type: "browser_state"`
526
527534 - `cache_control: optional CacheControlEphemeral or null`
528535
529536 Create a cache control breakpoint at this content block.
from line 551
544551 during a failed call gets no deferred `tab_opened`; it simply appears
545552 in the next result's `tabs` inventory.
546553
554 - `type: "tab_opened"`
555
547556 - `tab_id: string`
548557
549558 The `tab_id` of the opened tab, present in `tabs`.
from line 559
550559
551560 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
552561
553 - `type: "tab_opened"`
554
555562 - `BrowserStateChangeDownloadStarted object`
556563
557564 A file download that started during this call.
558565
566 - `type: "download_started"`
567
559568 - `download_id: string`
560569
561570 The caller-assigned identifier for this download, stable across the state changes reporting it.
from line 571
562571
563572 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
564573
565 - `type: "download_started"`
566
567574 - `url: string`
568575
569576 The final post-redirect URL the download was served from.
from line 584
577584 `download_started`, when the download finished during the call that
578585 started it (at most one state change per `download_id` per result).
579586
587 - `type: "download_completed"`
588
580589 - `download_id: string`
581590
582591 The caller-assigned identifier for this download, stable across the state changes reporting it.
from line 592
583592
584593 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
585594
586 - `type: "download_completed"`
587
588595 - `url: string`
589596
590597 The final post-redirect URL the download was served from.
from line 614
607614
608615 A file download that failed — or was cancelled — during this call.
609616
617 - `type: "download_failed"`
618
610619 - `download_id: string`
611620
612621 The caller-assigned identifier for this download, stable across the state changes reporting it.
from line 622
613622
614623 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
615624
616 - `type: "download_failed"`
617
618625 - `url: string`
619626
620627 The final post-redirect URL the download was served from.
from line 644
637644
638645 - `ServerToolUseBlockParam object`
639646
647 - `type: "server_tool_use"`
648
640649 - `id: string`
641650
642651 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 668
659668
660669 - `"tool_search_tool_bm25"`
661670
662 - `type: "server_tool_use"`
663
664671 - `cache_control: optional CacheControlEphemeral or null`
665672
666673 Create a cache control breakpoint at this content block.
from line 688
681688
682689 - `WebSearchToolResultBlockParam object`
683690
691 - `type: "web_search_tool_result"`
692
684693 - `content: WebSearchToolResultBlockParamContent`
685694
686695 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`
687696
697 - `type: "web_search_result"`
698
688699 - `encrypted_content: string`
689700
690701 - `title: string`
691702
692 - `type: "web_search_result"`
693
694703 - `url: string`
695704
696705 - `page_age: optional string or null`
from line 706
697706
698707 - `WebSearchToolRequestError object`
699708
709 - `type: "web_search_tool_result_error"`
710
700711 - `error_code: WebSearchToolResultErrorCode`
701712
702713 - `"invalid_tool_input"`
from line 722
711722
712723 - `"request_too_large"`
713724
714 - `type: "web_search_tool_result_error"`
715
716725 - `tool_use_id: string`
717726
718727 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
719728
720 - `type: "web_search_tool_result"`
721
722729 - `cache_control: optional CacheControlEphemeral or null`
723730
724731 Create a cache control breakpoint at this content block.
from line 746
739746
740747 - `WebFetchToolResultBlockParam object`
741748
749 - `type: "web_fetch_tool_result"`
750
742751 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`
743752
744753 - `WebFetchToolResultErrorBlockParam object`
745754
755 - `type: "web_fetch_tool_result_error"`
756
746757 - `error_code: WebFetchToolResultErrorCode`
747758
748759 - `"invalid_tool_input"`
from line 774
763774
764775 - `"unavailable"`
765776
766 - `type: "web_fetch_tool_result_error"`
777 - `"content_too_large"`
767778
768779 - `WebFetchBlockParam object`
769780
770 - `content: DocumentBlockParam`
771
772781 - `type: "web_fetch_result"`
773782
783 - `content: DocumentBlockParam`
784
774785 - `url: string`
775786
776787 Fetched content URL
from line 794
783794
784795 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
785796
786 - `type: "web_fetch_tool_result"`
787
788797 - `cache_control: optional CacheControlEphemeral or null`
789798
790799 Create a cache control breakpoint at this content block.
from line 814
805814
806815 - `CodeExecutionToolResultBlockParam object`
807816
817 - `type: "code_execution_tool_result"`
818
808819 - `content: CodeExecutionToolResultBlockParamContent`
809820
810821 Code execution result with encrypted stdout for PFC + web_search results.
from line 822
811822
812823 - `CodeExecutionToolResultErrorParam object`
813824
825 - `type: "code_execution_tool_result_error"`
826
814827 - `error_code: CodeExecutionToolResultErrorCode`
815828
816829 - `"invalid_tool_input"`
from line 834
821834
822835 - `"execution_time_exceeded"`
823836
824 - `type: "code_execution_tool_result_error"`
825
826837 - `CodeExecutionResultBlockParam object`
827838
839 - `type: "code_execution_result"`
840
828841 - `content: array of CodeExecutionOutputBlockParam`
829842
830 - `file_id: string`
831
832843 - `type: "code_execution_output"`
833844
845 - `file_id: string`
846
834847 - `return_code: number`
835848
836849 - `stderr: string`
from line 850
837850
838851 - `stdout: string`
839852
840 - `type: "code_execution_result"`
841
842853 - `EncryptedCodeExecutionResultBlockParam object`
843854
844855 Code execution result with encrypted stdout for PFC + web_search results.
845856
857 - `type: "encrypted_code_execution_result"`
858
846859 - `content: array of CodeExecutionOutputBlockParam`
847860
848 - `file_id: string`
849
850861 - `type: "code_execution_output"`
851862
863 - `file_id: string`
864
852865 - `encrypted_stdout: string`
853866
854867 - `return_code: number`
from line 868
855868
856869 - `stderr: string`
857870
858 - `type: "encrypted_code_execution_result"`
859
860871 - `tool_use_id: string`
861872
862873 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
863874
864 - `type: "code_execution_tool_result"`
865
866875 - `cache_control: optional CacheControlEphemeral or null`
867876
868877 Create a cache control breakpoint at this content block.
from line 878
869878
870879 - `BashCodeExecutionToolResultBlockParam object`
871880
881 - `type: "bash_code_execution_tool_result"`
882
872883 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
873884
874885 - `BashCodeExecutionToolResultErrorParam object`
875886
887 - `type: "bash_code_execution_tool_result_error"`
888
876889 - `error_code: BashCodeExecutionToolResultErrorCode`
877890
878891 - `"invalid_tool_input"`
from line 898
885898
886899 - `"output_file_too_large"`
887900
888 - `type: "bash_code_execution_tool_result_error"`
889
890901 - `BashCodeExecutionResultBlockParam object`
891902
903 - `type: "bash_code_execution_result"`
904
892905 - `content: array of BashCodeExecutionOutputBlockParam`
893906
894 - `file_id: string`
895
896907 - `type: "bash_code_execution_output"`
897908
909 - `file_id: string`
910
898911 - `return_code: number`
899912
900913 - `stderr: string`
from line 914
901914
902915 - `stdout: string`
903916
904 - `type: "bash_code_execution_result"`
905
906917 - `tool_use_id: string`
907918
908919 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
909920
910 - `type: "bash_code_execution_tool_result"`
911
912921 - `cache_control: optional CacheControlEphemeral or null`
913922
914923 Create a cache control breakpoint at this content block.
from line 924
915924
916925 - `TextEditorCodeExecutionToolResultBlockParam object`
917926
927 - `type: "text_editor_code_execution_tool_result"`
928
918929 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
919930
920931 - `TextEditorCodeExecutionToolResultErrorParam object`
921932
933 - `type: "text_editor_code_execution_tool_result_error"`
934
922935 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
923936
924937 - `"invalid_tool_input"`
from line 944
931944
932945 - `"file_not_found"`
933946
934 - `type: "text_editor_code_execution_tool_result_error"`
935
936947 - `error_message: optional string or null`
937948
938949 - `TextEditorCodeExecutionViewResultBlockParam object`
939950
951 - `type: "text_editor_code_execution_view_result"`
952
940953 - `content: string`
941954
942955 - `file_type: "text" or "image" or "pdf"`
from line 960
947960
948961 - `"pdf"`
949962
950 - `type: "text_editor_code_execution_view_result"`
951
952963 - `num_lines: optional number or null`
953964
954965 - `start_line: optional number or null`
from line 968
957968
958969 - `TextEditorCodeExecutionCreateResultBlockParam object`
959970
960 - `is_file_update: boolean`
961
962971 - `type: "text_editor_code_execution_create_result"`
963972
973 - `is_file_update: boolean`
974
964975 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
965976
966977 - `type: "text_editor_code_execution_str_replace_result"`
from line 990
979990
980991 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
981992
982 - `type: "text_editor_code_execution_tool_result"`
983
984993 - `cache_control: optional CacheControlEphemeral or null`
985994
986995 Create a cache control breakpoint at this content block.
from line 996
987996
988997 - `ToolSearchToolResultBlockParam object`
989998
999 - `type: "tool_search_tool_result"`
1000
9901001 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
9911002
9921003 - `ToolSearchToolResultErrorParam object`
9931004
1005 - `type: "tool_search_tool_result_error"`
1006
9941007 - `error_code: ToolSearchToolResultErrorCode`
9951008
9961009 - `"invalid_tool_input"`
from line 1014
10011014
10021015 - `"execution_time_exceeded"`
10031016
1004 - `type: "tool_search_tool_result_error"`
1005
10061017 - `error_message: optional string or null`
10071018
10081019 - `ToolSearchToolSearchResultBlockParam object`
10091020
1021 - `type: "tool_search_tool_search_result"`
1022
10101023 - `tool_references: array of ToolReferenceBlockParam`
10111024
1025 - `type: "tool_reference"`
1026
10121027 - `tool_name: string`
10131028
10141029 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
10151030
1016 - `type: "tool_reference"`
1017
10181031 - `cache_control: optional CacheControlEphemeral or null`
10191032
10201033 Create a cache control breakpoint at this content block.
10211034
1022 - `type: "tool_search_tool_search_result"`
1023
10241035 - `tool_use_id: string`
10251036
10261037 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
10271038
1028 - `type: "tool_search_tool_result"`
1029
10301039 - `cache_control: optional CacheControlEphemeral or null`
10311040
10321041 Create a cache control breakpoint at this content block.
from line 1045
10361045 A content block that represents a file to be uploaded to the container
10371046 Files uploaded via this block will be available in the container's input directory.
10381047
1039 - `file_id: string`
1040
10411048 - `type: "container_upload"`
10421049
1050 - `file_id: string`
1051
10431052 - `cache_control: optional CacheControlEphemeral or null`
10441053
10451054 Create a cache control breakpoint at this content block.
from line 1169
11601169
11611170 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
11621171
1172 - `type: "json_schema"`
1173
11631174 - `schema: map[unknown]`
11641175
11651176 The JSON schema of the format
11661177
1167 - `type: "json_schema"`
1168
11691178- `system: optional string or array of TextBlockParam`
11701179
11711180 System prompt.
from line 1185
11761185
11771186 - `array of TextBlockParam`
11781187
1188 - `type: "text"`
1189
11791190 - `text: string`
11801191
11811192 minLength: 1
11821193
1183 - `type: "text"`
1184
11851194 - `cache_control: optional CacheControlEphemeral or null`
11861195
11871196 Create a cache control breakpoint at this content block.
from line 1207
11981207
11991208 - `ThinkingConfigEnabled object`
12001209
1210 - `type: "enabled"`
1211
12011212 - `budget_tokens: number`
12021213
12031214 Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
from line 1219
12081219
12091220 minimum: 1024
12101221
1211 - `type: "enabled"`
1212
12131222 - `display: optional "summarized" or "omitted" or null`
12141223
12151224 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1275
12661275
12671276 The model will use the specified tool with `tool_choice.name`.
12681277
1278 - `type: "tool"`
1279
12691280 - `name: string`
12701281
12711282 The name of the tool to use.
12721283
1273 - `type: "tool"`
1274
12751284 - `disable_parallel_tool_use: optional boolean`
12761285
12771286 Whether to disable parallel tool use.
from line 1359
13501359
13511360 - `Tool object`
13521361
1362 - `type: optional "custom" or null`
1363
13531364 - `input_schema: object`
13541365
13551366 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
from line 1415
14041415
14051416 When true, guarantees schema validation on tool names and inputs
14061417
1407 - `type: optional "custom" or null`
1408
14091418 - `ToolBash20250124 object`
14101419
1420 - `type: "bash_20250124"`
1421
14111422 - `name: "bash"`
14121423
14131424 Name of the tool.
from line 1425
14141425
14151426 This is how the tool will be called by the model and in `tool_use` blocks.
14161427
1417 - `type: "bash_20250124"`
1418
14191428 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
14201429
14211430 - `"direct"`
from line 1451
14421451
14431452 - `CodeExecutionTool20250522 object`
14441453
1454 - `type: "code_execution_20250522"`
1455
14451456 - `name: "code_execution"`
14461457
14471458 Name of the tool.
from line 1459
14481459
14491460 This is how the tool will be called by the model and in `tool_use` blocks.
14501461
1451 - `type: "code_execution_20250522"`
1452
14531462 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
14541463
14551464 - `"direct"`
from line 1483
14741483
14751484 - `CodeExecutionTool20250825 object`
14761485
1486 - `type: "code_execution_20250825"`
1487
14771488 - `name: "code_execution"`
14781489
14791490 Name of the tool.
from line 1491
14801491
14811492 This is how the tool will be called by the model and in `tool_use` blocks.
14821493
1483 - `type: "code_execution_20250825"`
1484
14851494 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
14861495
14871496 - `"direct"`
from line 1517
15081517
15091518 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
15101519
1520 - `type: "code_execution_20260120"`
1521
15111522 - `name: "code_execution"`
15121523
15131524 Name of the tool.
from line 1525
15141525
15151526 This is how the tool will be called by the model and in `tool_use` blocks.
15161527
1517 - `type: "code_execution_20260120"`
1518
15191528 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15201529
15211530 - `"direct"`
from line 1551
15421551
15431552 Code execution tool with REPL state persistence.
15441553
1554 - `type: "code_execution_20260521"`
1555
15451556 - `name: "code_execution"`
15461557
15471558 Name of the tool.
from line 1559
15481559
15491560 This is how the tool will be called by the model and in `tool_use` blocks.
15501561
1551 - `type: "code_execution_20260521"`
1552
15531562 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15541563
15551564 - `"direct"`
from line 1603
15941603 absent. Unknown keys are rejected: the field set is this toolset
15951604 version's complete member set.
15961605
1606 - `type: optional BrowserTypeConfig or null`
1607
1608 `type`'s config overrides.
1609
1610 - `defer_loading: optional boolean or null`
1611
1612 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1613
1614 - `enabled: optional boolean or null`
1615
1616 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
1617
15971618 - `close_tab: optional BrowserCloseTabConfig or null`
15981619
15991620 `close_tab`'s config overrides.
from line 1951
19301951
19311952 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
19321953
1933 - `type: optional BrowserTypeConfig or null`
1934
1935 `type`'s config overrides.
1936
1937 - `defer_loading: optional boolean or null`
1938
1939 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1940
1941 - `enabled: optional boolean or null`
1942
1943 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
1944
19451954 - `wait: optional BrowserWaitConfig or null`
19461955
19471956 `wait`'s config overrides.
from line 1977
19681977
19691978 - `MemoryTool20250818 object`
19701979
1980 - `type: "memory_20250818"`
1981
19711982 - `name: "memory"`
19721983
19731984 Name of the tool.
from line 1985
19741985
19751986 This is how the tool will be called by the model and in `tool_use` blocks.
19761987
1977 - `type: "memory_20250818"`
1978
19791988 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
19801989
19811990 - `"direct"`
from line 2035
20262035 absent. Unknown keys are rejected: the field set is this toolset
20272036 version's complete member set.
20282037
2038 - `type: optional ComputerTypeConfig or null`
2039
2040 `type`'s config overrides.
2041
2042 - `defer_loading: optional boolean or null`
2043
2044 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2045
2046 - `enabled: optional boolean or null`
2047
2048 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2049
20292050 - `cursor_position: optional ComputerCursorPositionConfig or null`
20302051
20312052 `cursor_position`'s config overrides.
from line 2215
21942215
21952216 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
21962217
2197 - `type: optional ComputerTypeConfig or null`
2198
2199 `type`'s config overrides.
2200
2201 - `defer_loading: optional boolean or null`
2202
2203 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2204
2205 - `enabled: optional boolean or null`
2206
2207 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2208
22092218 - `wait: optional ComputerWaitConfig or null`
22102219
22112220 `wait`'s config overrides.
from line 2241
22322241
22332242 - `ToolTextEditor20250124 object`
22342243
2244 - `type: "text_editor_20250124"`
2245
22352246 - `name: "str_replace_editor"`
22362247
22372248 Name of the tool.
from line 2249
22382249
22392250 This is how the tool will be called by the model and in `tool_use` blocks.
22402251
2241 - `type: "text_editor_20250124"`
2242
22432252 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
22442253
22452254 - `"direct"`
from line 2275
22662275
22672276 - `ToolTextEditor20250429 object`
22682277
2278 - `type: "text_editor_20250429"`
2279
22692280 - `name: "str_replace_based_edit_tool"`
22702281
22712282 Name of the tool.
from line 2283
22722283
22732284 This is how the tool will be called by the model and in `tool_use` blocks.
22742285
2275 - `type: "text_editor_20250429"`
2276
22772286 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
22782287
22792288 - `"direct"`
from line 2309
23002309
23012310 - `ToolTextEditor20250728 object`
23022311
2312 - `type: "text_editor_20250728"`
2313
23032314 - `name: "str_replace_based_edit_tool"`
23042315
23052316 Name of the tool.
from line 2317
23062317
23072318 This is how the tool will be called by the model and in `tool_use` blocks.
23082319
2309 - `type: "text_editor_20250728"`
2310
23112320 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23122321
23132322 - `"direct"`
from line 2349
23402349
23412350 - `WebSearchTool20250305 object`
23422351
2352 - `type: "web_search_20250305"`
2353
23432354 - `name: "web_search"`
23442355
23452356 Name of the tool.
from line 2357
23462357
23472358 This is how the tool will be called by the model and in `tool_use` blocks.
23482359
2349 - `type: "web_search_20250305"`
2350
23512360 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23522361
23532362 - `"direct"`
from line 2425
24162425
24172426 - `WebFetchTool20250910 object`
24182427
2428 - `type: "web_fetch_20250910"`
2429
24192430 - `name: "web_fetch"`
24202431
24212432 Name of the tool.
from line 2433
24222433
24232434 This is how the tool will be called by the model and in `tool_use` blocks.
24242435
2425 - `type: "web_fetch_20250910"`
2426
24272436 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24282437
24292438 - `"direct"`
from line 2481
24722481
24732482 - `WebSearchTool20260209 object`
24742483
2484 - `type: "web_search_20260209"`
2485
24752486 - `name: "web_search"`
24762487
24772488 Name of the tool.
from line 2489
24782489
24792490 This is how the tool will be called by the model and in `tool_use` blocks.
24802491
2481 - `type: "web_search_20260209"`
2482
24832492 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24842493
24852494 - `"direct"`
from line 2531
25222531
25232532 - `WebFetchTool20260209 object`
25242533
2534 - `type: "web_fetch_20260209"`
2535
25252536 - `name: "web_fetch"`
25262537
25272538 Name of the tool.
from line 2539
25282539
25292540 This is how the tool will be called by the model and in `tool_use` blocks.
25302541
2531 - `type: "web_fetch_20260209"`
2532
25332542 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25342543
25352544 - `"direct"`
from line 2589
25802589
25812590 Web fetch tool with use_cache parameter for bypassing cached content.
25822591
2592 - `type: "web_fetch_20260309"`
2593
25832594 - `name: "web_fetch"`
25842595
25852596 Name of the tool.
from line 2597
25862597
25872598 This is how the tool will be called by the model and in `tool_use` blocks.
25882599
2589 - `type: "web_fetch_20260309"`
2590
25912600 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25922601
25932602 - `"direct"`
from line 2649
26402649
26412650 - `WebSearchTool20260318 object`
26422651
2652 - `type: "web_search_20260318"`
2653
26432654 - `name: "web_search"`
26442655
26452656 Name of the tool.
from line 2657
26462657
26472658 This is how the tool will be called by the model and in `tool_use` blocks.
26482659
2649 - `type: "web_search_20260318"`
2650
26512660 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
26522661
26532662 - `"direct"`
from line 2707
26982707
26992708 - `WebFetchTool20260318 object`
27002709
2710 - `type: "web_fetch_20260318"`
2711
27012712 - `name: "web_fetch"`
27022713
27032714 Name of the tool.
from line 2715
27042715
27052716 This is how the tool will be called by the model and in `tool_use` blocks.
27062717
2707 - `type: "web_fetch_20260318"`
2708
27092718 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27102719
27112720 - `"direct"`
from line 2775
27662775
27672776 - `ToolSearchToolBm25_20251119 object`
27682777
2769 - `name: "tool_search_tool_bm25"`
2770
2771 Name of the tool.
2772
2773 This is how the tool will be called by the model and in `tool_use` blocks.
2774
27752778 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
27762779
27772780 - `"tool_search_tool_bm25_20251119"`
from line 2781
27782781
27792782 - `"tool_search_tool_bm25"`
27802783
2784 - `name: "tool_search_tool_bm25"`
2785
2786 Name of the tool.
2787
2788 This is how the tool will be called by the model and in `tool_use` blocks.
2789
27812790 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27822791
27832792 - `"direct"`
from line 2811
28022811
28032812 - `ToolSearchToolRegex20251119 object`
28042813
2805 - `name: "tool_search_tool_regex"`
2806
2807 Name of the tool.
2808
2809 This is how the tool will be called by the model and in `tool_use` blocks.
2810
28112814 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
28122815
28132816 - `"tool_search_tool_regex_20251119"`
28142817
28152818 - `"tool_search_tool_regex"`
2819
2820 - `name: "tool_search_tool_regex"`
2821
2822 Name of the tool.
2823
2824 This is how the tool will be called by the model and in `tool_use` blocks.
28162825
28172826 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28182827
api/messages/create Changed · +785 / -774 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: Create a Message
3url: https://platform.claude.com/docs/en/api/messages/create
4---
5
16# Create a Message
27
38**POST** `/v1/messages`
from line 18
1318- `"anthropic-user-profile-id": optional string`
1419
1520 The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header.
21
22- `"anthropic-workspace-id": optional string`
1623
1724## Body parameters
1825
from line 94
8794
8895 - `TextBlockParam object`
8996
97 - `type: "text"`
98
9099 - `text: string`
91100
92101 minLength: 1
93
94 - `type: "text"`
95102
96103 - `cache_control: optional CacheControlEphemeral or null`
97104
from line 125
118125
119126 - `CitationCharLocationParam object`
120127
128 - `type: "char_location"`
129
121130 - `cited_text: string`
122131
123132 - `document_index: number`
from line 143
134143
135144 minimum: 0
136145
137 - `type: "char_location"`
138
139146 - `CitationPageLocationParam object`
140147
148 - `type: "page_location"`
149
141150 - `cited_text: string`
142151
143152 - `document_index: number`
from line 163
154163
155164 minimum: 1
156165
157 - `type: "page_location"`
158
159166 - `CitationContentBlockLocationParam object`
160167
168 - `type: "content_block_location"`
169
161170 - `cited_text: string`
162171
163172 The full text of the cited block range, concatenated.
from line 193
184193
185194 minimum: 0
186195
187 - `type: "content_block_location"`
188
189196 - `CitationWebSearchResultLocationParam object`
190197
198 - `type: "web_search_result_location"`
199
191200 - `cited_text: string`
192201
193202 - `encrypted_index: string`
from line 205
196205
197206 maxLength: 512, minLength: 1
198207
199 - `type: "web_search_result_location"`
200
201208 - `url: string`
202209
203210 minLength: 1
204211
205212 - `CitationSearchResultLocationParam object`
206213
214 - `type: "search_result_location"`
215
207216 - `cited_text: string`
208217
209218 The full text of the cited block range, concatenated.
from line 243
234243
235244 - `title: string or null`
236245
237 - `type: "search_result_location"`
238
239246 - `ImageBlockParam object`
240247
248 - `type: "image"`
249
241250 - `source: Base64ImageSource or URLImageSource or FileImageSource`
242251
243252 - `Base64ImageSource object`
244253
254 - `type: "base64"`
255
245256 - `data: string`
246257
247258 format: byte
from line 267
256267
257268 - `"image/webp"`
258269
270 - `URLImageSource object`
271
272 - `type: "url"`
273
274 - `url: string`
275
276 - `FileImageSource object`
277
278 - `type: "file"`
279
280 - `file_id: string`
281
282 - `cache_control: optional CacheControlEphemeral or null`
283
284 Create a cache control breakpoint at this content block.
285
286 - `transformations: optional ImageTransformationsParam or null`
287
288 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
289
290 - `oversized_image: optional "downsize" or "error"`
291
292 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
293
294 - `"downsize"`
295
296 - `"error"`
297
298 - `DocumentBlockParam object`
299
300 - `type: "document"`
301
302 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
303
304 - `Base64PDFSource object`
305
259306 - `type: "base64"`
260307
261 - `URLImageSource object`
308 - `data: string`
309
310 format: byte
311
312 - `media_type: "application/pdf"`
313
314 - `PlainTextSource object`
315
316 - `type: "text"`
317
318 - `data: string`
319
320 - `media_type: "text/plain"`
321
322 - `ContentBlockSource object`
323
324 - `type: "content"`
325
326 - `content: string or array of ContentBlockSourceContent`
327
328 - `string`
329
330 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
331
332 - `TextBlockParam object`
333
334 - `ImageBlockParam object`
335
336 - `URLPDFSource object`
262337
263338 - `type: "url"`
264339
265340 - `url: string`
266341
267 - `FileImageSource object`
342 - `FileDocumentSource object`
343
344 - `type: "file"`
268345
269346 - `file_id: string`
270347
271 - `type: "file"`
272
273 - `type: "image"`
274
275348 - `cache_control: optional CacheControlEphemeral or null`
276349
277350 Create a cache control breakpoint at this content block.
278351
279 - `transformations: optional ImageTransformationsParam or null`
280
281 Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.
282
283 - `oversized_image: optional "downsize" or "error"`
284
285 What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.
286
287 - `"downsize"`
288
289 - `"error"`
290
291 - `DocumentBlockParam object`
292
293 - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more`
294
295 - `Base64PDFSource object`
296
297 - `data: string`
298
299 format: byte
300
301 - `media_type: "application/pdf"`
302
303 - `type: "base64"`
304
305 - `PlainTextSource object`
306
307 - `data: string`
308
309 - `media_type: "text/plain"`
310
311 - `type: "text"`
312
313 - `ContentBlockSource object`
314
315 - `content: string or array of ContentBlockSourceContent`
316
317 - `string`
318
319 - `ContentBlockSourceContent = array of ContentBlockSourceContent`
320
321 - `TextBlockParam object`
322
323 - `ImageBlockParam object`
324
325 - `type: "content"`
326
327 - `URLPDFSource object`
328
329 - `type: "url"`
330
331 - `url: string`
332
333 - `FileDocumentSource object`
334
335 - `file_id: string`
336
337 - `type: "file"`
338
339 - `type: "document"`
352 - `citations: optional CitationsConfigParam or null`
353
354 - `enabled: optional boolean`
355
356 - `context: optional string or null`
357
358 minLength: 1
359
360 - `title: optional string or null`
361
362 maxLength: 500, minLength: 1
363
364 - `SearchResultBlockParam object`
365
366 - `type: "search_result"`
367
368 - `content: array of TextBlockParam`
369
370 - `type: "text"`
371
372 - `text: string`
373
374 minLength: 1
375
376 - `cache_control: optional CacheControlEphemeral or null`
377
378 Create a cache control breakpoint at this content block.
379
380 - `citations: optional array of TextCitationParam or null`
381
382 - `source: string`
383
384 - `title: string`
340385
341386 - `cache_control: optional CacheControlEphemeral or null`
342387
343388 Create a cache control breakpoint at this content block.
344389
345 - `citations: optional CitationsConfigParam or null`
346
347 - `enabled: optional boolean`
348
349 - `context: optional string or null`
350
351 minLength: 1
352
353 - `title: optional string or null`
354
355 maxLength: 500, minLength: 1
356
357 - `SearchResultBlockParam object`
358
359 - `content: array of TextBlockParam`
360
361 - `text: string`
362
363 minLength: 1
364
365 - `type: "text"`
366
367 - `cache_control: optional CacheControlEphemeral or null`
368
369 Create a cache control breakpoint at this content block.
370
371 - `citations: optional array of TextCitationParam or null`
372
373 - `source: string`
374
375 - `title: string`
376
377 - `type: "search_result"`
390 - `citations: optional CitationsConfigParam`
391
392 - `ThinkingBlockParam object`
393
394 - `type: "thinking"`
395
396 - `signature: string`
397
398 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
399
400 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
401
402 - `thinking: string`
403
404 The `thinking` text of this block as returned by the API.
405
406 - `RedactedThinkingBlockParam object`
407
408 - `type: "redacted_thinking"`
409
410 - `data: string`
411
412 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
413
414 - `ToolUseBlockParam object`
415
416 - `type: "tool_use"`
417
418 - `id: string`
419
420 pattern: ^[a-zA-Z0-9_-]+$
421
422 - `input: map[unknown]`
423
424 - `name: string`
425
426 maxLength: 200, minLength: 1
378427
379428 - `cache_control: optional CacheControlEphemeral or null`
380429
381430 Create a cache control breakpoint at this content block.
382431
383 - `citations: optional CitationsConfigParam`
384
385 - `ThinkingBlockParam object`
386
387 - `signature: string`
388
389 The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.
390
391 Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`.
392
393 - `thinking: string`
394
395 The `thinking` text of this block as returned by the API.
396
397 - `type: "thinking"`
398
399 - `RedactedThinkingBlockParam object`
400
401 - `data: string`
402
403 The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.
404
405 - `type: "redacted_thinking"`
406
407 - `ToolUseBlockParam object`
408
409 - `id: string`
432 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
433
434 Tool invocation directly from the model.
435
436 - `DirectCaller object`
437
438 Tool invocation directly from the model.
439
440 - `type: "direct"`
441
442 - `ServerToolCaller object`
443
444 Tool invocation generated by a server-side tool.
445
446 - `type: "code_execution_20250825"`
447
448 - `tool_id: string`
449
450 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
451
452 - `ServerToolCaller20260120 object`
453
454 - `type: "code_execution_20260120"`
455
456 - `tool_id: string`
457
458 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
459
460 - `toolset_name: optional string or null`
461
462 For a toolset member tool_use, the toolset family this member belongs to.
463
464 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
465
466 - `ToolResultBlockParam object`
467
468 - `type: "tool_result"`
469
470 - `tool_use_id: string`
410471
411472 pattern: ^[a-zA-Z0-9_-]+$
412473
413 - `input: map[unknown]`
414
415 - `name: string`
416
417 maxLength: 200, minLength: 1
418
419 - `type: "tool_use"`
420
421474 - `cache_control: optional CacheControlEphemeral or null`
422475
423476 Create a cache control breakpoint at this content block.
424477
425 - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120`
426
427 Tool invocation directly from the model.
428
429 - `DirectCaller object`
430
431 Tool invocation directly from the model.
432
433 - `type: "direct"`
434
435 - `ServerToolCaller object`
436
437 Tool invocation generated by a server-side tool.
438
439 - `tool_id: string`
440
441 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
442
443 - `type: "code_execution_20250825"`
444
445 - `ServerToolCaller20260120 object`
446
447 - `tool_id: string`
448
449 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
450
451 - `type: "code_execution_20260120"`
452
453 - `toolset_name: optional string or null`
454
455 For a toolset member tool_use, the toolset family this member belongs to.
456
457 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
458
459 - `ToolResultBlockParam object`
460
461 - `tool_use_id: string`
462
463 pattern: ^[a-zA-Z0-9_-]+$
464
465 - `type: "tool_result"`
466
467 - `cache_control: optional CacheControlEphemeral or null`
468
469 Create a cache control breakpoint at this content block.
470
471478 - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more`
472479
473480 - `string`
from line 493
486493
487494 Tool reference block that can be included in tool_result content.
488495
496 - `type: "tool_reference"`
497
489498 - `tool_name: string`
490499
491500 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
492
493 - `type: "tool_reference"`
494501
495502 - `cache_control: optional CacheControlEphemeral or null`
496503
from line 513
506513 browser toolset member `tool_use`. The server renders the
507514 model-visible text from it; the model never sees the raw fields.
508515
516 - `type: "browser_state"`
517
509518 - `tabs: array of BrowserStateTabEntry`
510519
511520 All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`.
from line 542
533542 - `active: optional boolean`
534543
535544 Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`.
536
537 - `type: "browser_state"`
538545
539546 - `cache_control: optional CacheControlEphemeral or null`
540547
from line 563
556563 during a failed call gets no deferred `tab_opened`; it simply appears
557564 in the next result's `tabs` inventory.
558565
566 - `type: "tab_opened"`
567
559568 - `tab_id: string`
560569
561570 The `tab_id` of the opened tab, present in `tabs`.
562571
563572 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
564573
565 - `type: "tab_opened"`
566
567574 - `BrowserStateChangeDownloadStarted object`
568575
569576 A file download that started during this call.
570577
578 - `type: "download_started"`
579
571580 - `download_id: string`
572581
573582 The caller-assigned identifier for this download, stable across the state changes reporting it.
574583
575584 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
576
577 - `type: "download_started"`
578585
579586 - `url: string`
580587
from line 596
589596 `download_started`, when the download finished during the call that
590597 started it (at most one state change per `download_id` per result).
591598
599 - `type: "download_completed"`
600
592601 - `download_id: string`
593602
594603 The caller-assigned identifier for this download, stable across the state changes reporting it.
595604
596605 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
597606
598 - `type: "download_completed"`
599
600607 - `url: string`
601608
602609 The final post-redirect URL the download was served from.
from line 626
619626
620627 A file download that failed — or was cancelled — during this call.
621628
629 - `type: "download_failed"`
630
622631 - `download_id: string`
623632
624633 The caller-assigned identifier for this download, stable across the state changes reporting it.
625634
626635 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
627636
628 - `type: "download_failed"`
629
630637 - `url: string`
631638
632639 The final post-redirect URL the download was served from.
from line 656
649656
650657 - `ServerToolUseBlockParam object`
651658
659 - `type: "server_tool_use"`
660
652661 - `id: string`
653662
654663 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 680
671680
672681 - `"tool_search_tool_bm25"`
673682
674 - `type: "server_tool_use"`
675
676683 - `cache_control: optional CacheControlEphemeral or null`
677684
678685 Create a cache control breakpoint at this content block.
from line 700
693700
694701 - `WebSearchToolResultBlockParam object`
695702
703 - `type: "web_search_tool_result"`
704
696705 - `content: WebSearchToolResultBlockParamContent`
697706
698707 - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam`
699708
709 - `type: "web_search_result"`
710
700711 - `encrypted_content: string`
701712
702713 - `title: string`
703714
704 - `type: "web_search_result"`
705
706715 - `url: string`
707716
708717 - `page_age: optional string or null`
709718
710719 - `WebSearchToolRequestError object`
711720
721 - `type: "web_search_tool_result_error"`
722
712723 - `error_code: WebSearchToolResultErrorCode`
713724
714725 - `"invalid_tool_input"`
from line 734
723734
724735 - `"request_too_large"`
725736
726 - `type: "web_search_tool_result_error"`
727
728737 - `tool_use_id: string`
729738
730739 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
731740
732 - `type: "web_search_tool_result"`
733
734741 - `cache_control: optional CacheControlEphemeral or null`
735742
736743 Create a cache control breakpoint at this content block.
from line 758
751758
752759 - `WebFetchToolResultBlockParam object`
753760
761 - `type: "web_fetch_tool_result"`
762
754763 - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam`
755764
756765 - `WebFetchToolResultErrorBlockParam object`
757766
767 - `type: "web_fetch_tool_result_error"`
768
758769 - `error_code: WebFetchToolResultErrorCode`
759770
760771 - `"invalid_tool_input"`
from line 786
775786
776787 - `"unavailable"`
777788
778 - `type: "web_fetch_tool_result_error"`
789 - `"content_too_large"`
779790
780791 - `WebFetchBlockParam object`
781792
793 - `type: "web_fetch_result"`
794
782795 - `content: DocumentBlockParam`
783796
784 - `type: "web_fetch_result"`
785
786797 - `url: string`
787798
788799 Fetched content URL
from line 806
795806
796807 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
797808
798 - `type: "web_fetch_tool_result"`
799
800809 - `cache_control: optional CacheControlEphemeral or null`
801810
802811 Create a cache control breakpoint at this content block.
from line 826
817826
818827 - `CodeExecutionToolResultBlockParam object`
819828
829 - `type: "code_execution_tool_result"`
830
820831 - `content: CodeExecutionToolResultBlockParamContent`
821832
822833 Code execution result with encrypted stdout for PFC + web_search results.
823834
824835 - `CodeExecutionToolResultErrorParam object`
825836
837 - `type: "code_execution_tool_result_error"`
838
826839 - `error_code: CodeExecutionToolResultErrorCode`
827840
828841 - `"invalid_tool_input"`
from line 846
833846
834847 - `"execution_time_exceeded"`
835848
836 - `type: "code_execution_tool_result_error"`
837
838849 - `CodeExecutionResultBlockParam object`
839850
851 - `type: "code_execution_result"`
852
840853 - `content: array of CodeExecutionOutputBlockParam`
841854
855 - `type: "code_execution_output"`
856
842857 - `file_id: string`
843858
859 - `return_code: number`
860
861 - `stderr: string`
862
863 - `stdout: string`
864
865 - `EncryptedCodeExecutionResultBlockParam object`
866
867 Code execution result with encrypted stdout for PFC + web_search results.
868
869 - `type: "encrypted_code_execution_result"`
870
871 - `content: array of CodeExecutionOutputBlockParam`
872
844873 - `type: "code_execution_output"`
845874
875 - `file_id: string`
876
877 - `encrypted_stdout: string`
878
846879 - `return_code: number`
847880
848881 - `stderr: string`
849882
883 - `tool_use_id: string`
884
885 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
886
887 - `cache_control: optional CacheControlEphemeral or null`
888
889 Create a cache control breakpoint at this content block.
890
891 - `BashCodeExecutionToolResultBlockParam object`
892
893 - `type: "bash_code_execution_tool_result"`
894
895 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
896
897 - `BashCodeExecutionToolResultErrorParam object`
898
899 - `type: "bash_code_execution_tool_result_error"`
900
901 - `error_code: BashCodeExecutionToolResultErrorCode`
902
903 - `"invalid_tool_input"`
904
905 - `"unavailable"`
906
907 - `"too_many_requests"`
908
909 - `"execution_time_exceeded"`
910
911 - `"output_file_too_large"`
912
913 - `BashCodeExecutionResultBlockParam object`
914
915 - `type: "bash_code_execution_result"`
916
917 - `content: array of BashCodeExecutionOutputBlockParam`
918
919 - `type: "bash_code_execution_output"`
920
921 - `file_id: string`
922
923 - `return_code: number`
924
925 - `stderr: string`
926
850927 - `stdout: string`
851928
852 - `type: "code_execution_result"`
853
854 - `EncryptedCodeExecutionResultBlockParam object`
855
856 Code execution result with encrypted stdout for PFC + web_search results.
857
858 - `content: array of CodeExecutionOutputBlockParam`
859
860 - `file_id: string`
861
862 - `type: "code_execution_output"`
863
864 - `encrypted_stdout: string`
865
866 - `return_code: number`
867
868 - `stderr: string`
869
870 - `type: "encrypted_code_execution_result"`
871
872929 - `tool_use_id: string`
873930
874931 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
875932
876 - `type: "code_execution_tool_result"`
877
878933 - `cache_control: optional CacheControlEphemeral or null`
879934
880935 Create a cache control breakpoint at this content block.
881936
882 - `BashCodeExecutionToolResultBlockParam object`
883
884 - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam`
885
886 - `BashCodeExecutionToolResultErrorParam object`
887
888 - `error_code: BashCodeExecutionToolResultErrorCode`
937 - `TextEditorCodeExecutionToolResultBlockParam object`
938
939 - `type: "text_editor_code_execution_tool_result"`
940
941 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
942
943 - `TextEditorCodeExecutionToolResultErrorParam object`
944
945 - `type: "text_editor_code_execution_tool_result_error"`
946
947 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
889948
890949 - `"invalid_tool_input"`
891950
from line 954
895954
896955 - `"execution_time_exceeded"`
897956
898 - `"output_file_too_large"`
899
900 - `type: "bash_code_execution_tool_result_error"`
901
902 - `BashCodeExecutionResultBlockParam object`
903
904 - `content: array of BashCodeExecutionOutputBlockParam`
905
906 - `file_id: string`
907
908 - `type: "bash_code_execution_output"`
909
910 - `return_code: number`
911
912 - `stderr: string`
913
914 - `stdout: string`
915
916 - `type: "bash_code_execution_result"`
957 - `"file_not_found"`
958
959 - `error_message: optional string or null`
960
961 - `TextEditorCodeExecutionViewResultBlockParam object`
962
963 - `type: "text_editor_code_execution_view_result"`
964
965 - `content: string`
966
967 - `file_type: "text" or "image" or "pdf"`
968
969 - `"text"`
970
971 - `"image"`
972
973 - `"pdf"`
974
975 - `num_lines: optional number or null`
976
977 - `start_line: optional number or null`
978
979 - `total_lines: optional number or null`
980
981 - `TextEditorCodeExecutionCreateResultBlockParam object`
982
983 - `type: "text_editor_code_execution_create_result"`
984
985 - `is_file_update: boolean`
986
987 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
988
989 - `type: "text_editor_code_execution_str_replace_result"`
990
991 - `lines: optional array of string or null`
992
993 - `new_lines: optional number or null`
994
995 - `new_start: optional number or null`
996
997 - `old_lines: optional number or null`
998
999 - `old_start: optional number or null`
9171000
9181001 - `tool_use_id: string`
9191002
9201003 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
9211004
922 - `type: "bash_code_execution_tool_result"`
923
9241005 - `cache_control: optional CacheControlEphemeral or null`
9251006
9261007 Create a cache control breakpoint at this content block.
9271008
928 - `TextEditorCodeExecutionToolResultBlockParam object`
929
930 - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam`
931
932 - `TextEditorCodeExecutionToolResultErrorParam object`
933
934 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
1009 - `ToolSearchToolResultBlockParam object`
1010
1011 - `type: "tool_search_tool_result"`
1012
1013 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1014
1015 - `ToolSearchToolResultErrorParam object`
1016
1017 - `type: "tool_search_tool_result_error"`
1018
1019 - `error_code: ToolSearchToolResultErrorCode`
9351020
9361021 - `"invalid_tool_input"`
9371022
from line 1026
9411026
9421027 - `"execution_time_exceeded"`
9431028
944 - `"file_not_found"`
945
946 - `type: "text_editor_code_execution_tool_result_error"`
947
9481029 - `error_message: optional string or null`
9491030
950 - `TextEditorCodeExecutionViewResultBlockParam object`
951
952 - `content: string`
953
954 - `file_type: "text" or "image" or "pdf"`
955
956 - `"text"`
957
958 - `"image"`
959
960 - `"pdf"`
961
962 - `type: "text_editor_code_execution_view_result"`
963
964 - `num_lines: optional number or null`
965
966 - `start_line: optional number or null`
967
968 - `total_lines: optional number or null`
969
970 - `TextEditorCodeExecutionCreateResultBlockParam object`
971
972 - `is_file_update: boolean`
973
974 - `type: "text_editor_code_execution_create_result"`
975
976 - `TextEditorCodeExecutionStrReplaceResultBlockParam object`
977
978 - `type: "text_editor_code_execution_str_replace_result"`
979
980 - `lines: optional array of string or null`
981
982 - `new_lines: optional number or null`
983
984 - `new_start: optional number or null`
985
986 - `old_lines: optional number or null`
987
988 - `old_start: optional number or null`
1031 - `ToolSearchToolSearchResultBlockParam object`
1032
1033 - `type: "tool_search_tool_search_result"`
1034
1035 - `tool_references: array of ToolReferenceBlockParam`
1036
1037 - `type: "tool_reference"`
1038
1039 - `tool_name: string`
1040
1041 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1042
1043 - `cache_control: optional CacheControlEphemeral or null`
1044
1045 Create a cache control breakpoint at this content block.
9891046
9901047 - `tool_use_id: string`
9911048
9921049 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
993
994 - `type: "text_editor_code_execution_tool_result"`
995
996 - `cache_control: optional CacheControlEphemeral or null`
997
998 Create a cache control breakpoint at this content block.
999
1000 - `ToolSearchToolResultBlockParam object`
1001
1002 - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam`
1003
1004 - `ToolSearchToolResultErrorParam object`
1005
1006 - `error_code: ToolSearchToolResultErrorCode`
1007
1008 - `"invalid_tool_input"`
1009
1010 - `"unavailable"`
1011
1012 - `"too_many_requests"`
1013
1014 - `"execution_time_exceeded"`
1015
1016 - `type: "tool_search_tool_result_error"`
1017
1018 - `error_message: optional string or null`
1019
1020 - `ToolSearchToolSearchResultBlockParam object`
1021
1022 - `tool_references: array of ToolReferenceBlockParam`
1023
1024 - `tool_name: string`
1025
1026 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1027
1028 - `type: "tool_reference"`
1029
1030 - `cache_control: optional CacheControlEphemeral or null`
1031
1032 Create a cache control breakpoint at this content block.
1033
1034 - `type: "tool_search_tool_search_result"`
1035
1036 - `tool_use_id: string`
1037
1038 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
1039
1040 - `type: "tool_search_tool_result"`
10411050
10421051 - `cache_control: optional CacheControlEphemeral or null`
10431052
from line 1057
10481057 A content block that represents a file to be uploaded to the container
10491058 Files uploaded via this block will be available in the container's input directory.
10501059
1060 - `type: "container_upload"`
1061
10511062 - `file_id: string`
10521063
1053 - `type: "container_upload"`
1054
10551064 - `cache_control: optional CacheControlEphemeral or null`
10561065
10571066 Create a cache control breakpoint at this content block.
from line 1177
11681177
11691178 maxItems: 20
11701179
1180 - `type: "anthropic" or "custom"`
1181
1182 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1183
1184 - `"anthropic"`
1185
1186 - `"custom"`
1187
11711188 - `skill_id: string`
11721189
11731190 Skill ID
11741191
11751192 maxLength: 64, minLength: 1
11761193
1177 - `type: "anthropic" or "custom"`
1178
1179 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
1180
1181 - `"anthropic"`
1182
1183 - `"custom"`
1184
11851194 - `version: optional string`
11861195
11871196 Skill version or 'latest' for most recent version
from line 1237
12281237
12291238 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
12301239
1240 - `type: "json_schema"`
1241
12311242 - `schema: map[unknown]`
12321243
12331244 The JSON schema of the format
12341245
1235 - `type: "json_schema"`
1236
12371246- `service_tier: optional "auto" or "standard_only"`
12381247
12391248 Determines whether to use priority capacity (if available) or standard capacity for this request.
from line 1277
12681277
12691278 - `array of TextBlockParam`
12701279
1280 - `type: "text"`
1281
12711282 - `text: string`
12721283
12731284 minLength: 1
12741285
1275 - `type: "text"`
1276
12771286 - `cache_control: optional CacheControlEphemeral or null`
12781287
12791288 Create a cache control breakpoint at this content block.
from line 1299
12901299
12911300 - `ThinkingConfigEnabled object`
12921301
1302 - `type: "enabled"`
1303
12931304 - `budget_tokens: number`
12941305
12951306 Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
from line 1311
13001311
13011312 minimum: 1024
13021313
1303 - `type: "enabled"`
1304
13051314 - `display: optional "summarized" or "omitted" or null`
13061315
13071316 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1367
13581367
13591368 The model will use the specified tool with `tool_choice.name`.
13601369
1370 - `type: "tool"`
1371
13611372 - `name: string`
13621373
13631374 The name of the tool to use.
1364
1365 - `type: "tool"`
13661375
13671376 - `disable_parallel_tool_use: optional boolean`
13681377
from line 1451
14421451
14431452 - `Tool object`
14441453
1454 - `type: optional "custom" or null`
1455
14451456 - `input_schema: object`
14461457
14471458 [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
from line 1507
14961507
14971508 When true, guarantees schema validation on tool names and inputs
14981509
1499 - `type: optional "custom" or null`
1500
15011510 - `ToolBash20250124 object`
15021511
1512 - `type: "bash_20250124"`
1513
15031514 - `name: "bash"`
15041515
15051516 Name of the tool.
15061517
15071518 This is how the tool will be called by the model and in `tool_use` blocks.
15081519
1509 - `type: "bash_20250124"`
1510
15111520 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15121521
15131522 - `"direct"`
from line 1543
15341543
15351544 - `CodeExecutionTool20250522 object`
15361545
1546 - `type: "code_execution_20250522"`
1547
15371548 - `name: "code_execution"`
15381549
15391550 Name of the tool.
15401551
15411552 This is how the tool will be called by the model and in `tool_use` blocks.
15421553
1543 - `type: "code_execution_20250522"`
1544
15451554 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15461555
15471556 - `"direct"`
from line 1575
15661575
15671576 - `CodeExecutionTool20250825 object`
15681577
1578 - `type: "code_execution_20250825"`
1579
15691580 - `name: "code_execution"`
15701581
15711582 Name of the tool.
15721583
15731584 This is how the tool will be called by the model and in `tool_use` blocks.
15741585
1575 - `type: "code_execution_20250825"`
1576
15771586 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
15781587
15791588 - `"direct"`
from line 1609
16001609
16011610 Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
16021611
1612 - `type: "code_execution_20260120"`
1613
16031614 - `name: "code_execution"`
16041615
16051616 Name of the tool.
16061617
16071618 This is how the tool will be called by the model and in `tool_use` blocks.
16081619
1609 - `type: "code_execution_20260120"`
1610
16111620 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16121621
16131622 - `"direct"`
from line 1643
16341643
16351644 Code execution tool with REPL state persistence.
16361645
1646 - `type: "code_execution_20260521"`
1647
16371648 - `name: "code_execution"`
16381649
16391650 Name of the tool.
16401651
16411652 This is how the tool will be called by the model and in `tool_use` blocks.
1642
1643 - `type: "code_execution_20260521"`
16441653
16451654 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
16461655
from line 1695
16861695 absent. Unknown keys are rejected: the field set is this toolset
16871696 version's complete member set.
16881697
1698 - `type: optional BrowserTypeConfig or null`
1699
1700 `type`'s config overrides.
1701
1702 - `defer_loading: optional boolean or null`
1703
1704 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
1705
1706 - `enabled: optional boolean or null`
1707
1708 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
1709
16891710 - `close_tab: optional BrowserCloseTabConfig or null`
16901711
16911712 `close_tab`'s config overrides.
from line 2043
20222043
20232044 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
20242045
2025 - `type: optional BrowserTypeConfig or null`
2026
2027 `type`'s config overrides.
2028
2029 - `defer_loading: optional boolean or null`
2030
2031 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2032
2033 - `enabled: optional boolean or null`
2034
2035 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2036
20372046 - `wait: optional BrowserWaitConfig or null`
20382047
20392048 `wait`'s config overrides.
from line 2069
20602069
20612070 - `MemoryTool20250818 object`
20622071
2072 - `type: "memory_20250818"`
2073
20632074 - `name: "memory"`
20642075
20652076 Name of the tool.
20662077
20672078 This is how the tool will be called by the model and in `tool_use` blocks.
2068
2069 - `type: "memory_20250818"`
20702079
20712080 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
20722081
from line 2127
21182127 absent. Unknown keys are rejected: the field set is this toolset
21192128 version's complete member set.
21202129
2130 - `type: optional ComputerTypeConfig or null`
2131
2132 `type`'s config overrides.
2133
2134 - `defer_loading: optional boolean or null`
2135
2136 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2137
2138 - `enabled: optional boolean or null`
2139
2140 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2141
21212142 - `cursor_position: optional ComputerCursorPositionConfig or null`
21222143
21232144 `cursor_position`'s config overrides.
from line 2307
22862307
22872308 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
22882309
2289 - `type: optional ComputerTypeConfig or null`
2290
2291 `type`'s config overrides.
2292
2293 - `defer_loading: optional boolean or null`
2294
2295 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
2296
2297 - `enabled: optional boolean or null`
2298
2299 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
2300
23012310 - `wait: optional ComputerWaitConfig or null`
23022311
23032312 `wait`'s config overrides.
from line 2333
23242333
23252334 - `ToolTextEditor20250124 object`
23262335
2336 - `type: "text_editor_20250124"`
2337
23272338 - `name: "str_replace_editor"`
23282339
23292340 Name of the tool.
23302341
23312342 This is how the tool will be called by the model and in `tool_use` blocks.
23322343
2333 - `type: "text_editor_20250124"`
2334
23352344 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23362345
23372346 - `"direct"`
from line 2367
23582367
23592368 - `ToolTextEditor20250429 object`
23602369
2370 - `type: "text_editor_20250429"`
2371
23612372 - `name: "str_replace_based_edit_tool"`
23622373
23632374 Name of the tool.
23642375
23652376 This is how the tool will be called by the model and in `tool_use` blocks.
23662377
2367 - `type: "text_editor_20250429"`
2368
23692378 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
23702379
23712380 - `"direct"`
from line 2401
23922401
23932402 - `ToolTextEditor20250728 object`
23942403
2404 - `type: "text_editor_20250728"`
2405
23952406 - `name: "str_replace_based_edit_tool"`
23962407
23972408 Name of the tool.
23982409
23992410 This is how the tool will be called by the model and in `tool_use` blocks.
24002411
2401 - `type: "text_editor_20250728"`
2402
24032412 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24042413
24052414 - `"direct"`
from line 2441
24322441
24332442 - `WebSearchTool20250305 object`
24342443
2444 - `type: "web_search_20250305"`
2445
24352446 - `name: "web_search"`
24362447
24372448 Name of the tool.
24382449
24392450 This is how the tool will be called by the model and in `tool_use` blocks.
24402451
2441 - `type: "web_search_20250305"`
2442
24432452 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
24442453
24452454 - `"direct"`
from line 2517
25082517
25092518 - `WebFetchTool20250910 object`
25102519
2520 - `type: "web_fetch_20250910"`
2521
25112522 - `name: "web_fetch"`
25122523
25132524 Name of the tool.
25142525
25152526 This is how the tool will be called by the model and in `tool_use` blocks.
25162527
2517 - `type: "web_fetch_20250910"`
2518
25192528 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25202529
25212530 - `"direct"`
from line 2573
25642573
25652574 - `WebSearchTool20260209 object`
25662575
2576 - `type: "web_search_20260209"`
2577
25672578 - `name: "web_search"`
25682579
25692580 Name of the tool.
25702581
25712582 This is how the tool will be called by the model and in `tool_use` blocks.
25722583
2573 - `type: "web_search_20260209"`
2574
25752584 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25762585
25772586 - `"direct"`
from line 2623
26142623
26152624 - `WebFetchTool20260209 object`
26162625
2626 - `type: "web_fetch_20260209"`
2627
26172628 - `name: "web_fetch"`
26182629
26192630 Name of the tool.
26202631
26212632 This is how the tool will be called by the model and in `tool_use` blocks.
26222633
2623 - `type: "web_fetch_20260209"`
2624
26252634 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
26262635
26272636 - `"direct"`
from line 2681
26722681
26732682 Web fetch tool with use_cache parameter for bypassing cached content.
26742683
2684 - `type: "web_fetch_20260309"`
2685
26752686 - `name: "web_fetch"`
26762687
26772688 Name of the tool.
26782689
26792690 This is how the tool will be called by the model and in `tool_use` blocks.
26802691
2681 - `type: "web_fetch_20260309"`
2682
26832692 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
26842693
26852694 - `"direct"`
from line 2741
27322741
27332742 - `WebSearchTool20260318 object`
27342743
2744 - `type: "web_search_20260318"`
2745
27352746 - `name: "web_search"`
27362747
27372748 Name of the tool.
27382749
27392750 This is how the tool will be called by the model and in `tool_use` blocks.
27402751
2741 - `type: "web_search_20260318"`
2742
27432752 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
27442753
27452754 - `"direct"`
from line 2799
27902799
27912800 - `WebFetchTool20260318 object`
27922801
2802 - `type: "web_fetch_20260318"`
2803
27932804 - `name: "web_fetch"`
27942805
27952806 Name of the tool.
27962807
27972808 This is how the tool will be called by the model and in `tool_use` blocks.
27982809
2799 - `type: "web_fetch_20260318"`
2800
28012810 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28022811
28032812 - `"direct"`
from line 2867
28582867
28592868 - `ToolSearchToolBm25_20251119 object`
28602869
2870 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2871
2872 - `"tool_search_tool_bm25_20251119"`
2873
2874 - `"tool_search_tool_bm25"`
2875
28612876 - `name: "tool_search_tool_bm25"`
28622877
28632878 Name of the tool.
28642879
28652880 This is how the tool will be called by the model and in `tool_use` blocks.
28662881
2867 - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"`
2868
2869 - `"tool_search_tool_bm25_20251119"`
2870
2871 - `"tool_search_tool_bm25"`
2872
28732882 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
28742883
28752884 - `"direct"`
from line 2903
28942903
28952904 - `ToolSearchToolRegex20251119 object`
28962905
2906 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2907
2908 - `"tool_search_tool_regex_20251119"`
2909
2910 - `"tool_search_tool_regex"`
2911
28972912 - `name: "tool_search_tool_regex"`
28982913
28992914 Name of the tool.
29002915
29012916 This is how the tool will be called by the model and in `tool_use` blocks.
29022917
2903 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
2904
2905 - `"tool_search_tool_regex_20251119"`
2906
2907 - `"tool_search_tool_regex"`
2908
29092918 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
29102919
29112920 - `"direct"`
from line 2977
29682977
29692978- `Message object`
29702979
2980 - `type: "message"`
2981
2982 Object type.
2983
2984 For Messages, this is always `"message"`.
2985
2986 default: message
2987
29712988 - `id: string`
29722989
29732990 Unique object identifier.
from line 3009
29923009
29933010 Skills loaded in the container
29943011
3012 - `type: "anthropic" or "custom"`
3013
3014 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
3015
3016 - `"anthropic"`
3017
3018 - `"custom"`
3019
29953020 - `skill_id: string`
29963021
29973022 Skill ID
29983023
29993024 maxLength: 64, minLength: 1
3000
3001 - `type: "anthropic" or "custom"`
3002
3003 Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
3004
3005 - `"anthropic"`
3006
3007 - `"custom"`
30083025
30093026 - `version: string`
30103027
from line 3060
30433060
30443061 - `TextBlock object`
30453062
3063 - `type: "text"`
3064
3065 default: text
3066
30463067 - `citations: array of TextCitation or null`
30473068
30483069 Citations supporting the text block.
from line 3072
30513072
30523073 - `CitationCharLocation object`
30533074
3075 - `type: "char_location"`
3076
3077 default: char_location
3078
30543079 - `cited_text: string`
30553080
30563081 - `document_index: number`
from line 3092
30673092
30683093 minimum: 0
30693094
3070 - `type: "char_location"`
3071
3072 default: char_location
3073
30743095 - `CitationPageLocation object`
30753096
3097 - `type: "page_location"`
3098
3099 default: page_location
3100
30763101 - `cited_text: string`
30773102
30783103 - `document_index: number`
from line 3114
30893114
30903115 minimum: 1
30913116
3092 - `type: "page_location"`
3093
3094 default: page_location
3095
30963117 - `CitationContentBlockLocation object`
30973118
3119 - `type: "content_block_location"`
3120
3121 default: content_block_location
3122
30983123 - `cited_text: string`
30993124
31003125 The full text of the cited block range, concatenated.
from line 3146
31213146
31223147 minimum: 0
31233148
3124 - `type: "content_block_location"`
3125
3126 default: content_block_location
3127
31283149 - `CitationsWebSearchResultLocation object`
31293150
3151 - `type: "web_search_result_location"`
3152
3153 default: web_search_result_location
3154
31303155 - `cited_text: string`
31313156
31323157 - `encrypted_index: string`
from line 3160
31353160
31363161 maxLength: 512
31373162
3138 - `type: "web_search_result_location"`
3139
3140 default: web_search_result_location
3141
31423163 - `url: string`
31433164
31443165 - `CitationsSearchResultLocation object`
31453166
3167 - `type: "search_result_location"`
3168
3169 default: search_result_location
3170
31463171 - `cited_text: string`
31473172
31483173 The full text of the cited block range, concatenated.
from line 3198
31733198
31743199 - `title: string or null`
31753200
3176 - `type: "search_result_location"`
3177
3178 default: search_result_location
3179
31803201 - `text: string`
31813202
3182 maxLength: 5000000, minLength: 0
3183
3184 - `type: "text"`
3185
3186 default: text
3203 minLength: 0
31873204
31883205 - `ThinkingBlock object`
31893206
3207 - `type: "thinking"`
3208
3209 default: thinking
3210
31903211 - `signature: string`
31913212
31923213 A value used to verify that this thinking block was generated by Claude when it is passed back to the API.
from line 3220
31993220
32003221 The text of Claude's thinking process for this block.
32013222
3202 - `type: "thinking"`
3203
3204 default: thinking
3205
32063223 - `RedactedThinkingBlock object`
32073224
3225 - `type: "redacted_thinking"`
3226
3227 default: redacted_thinking
3228
32083229 - `data: string`
32093230
32103231 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 3234
32133234
32143235 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
32153236
3216 - `type: "redacted_thinking"`
3217
3218 default: redacted_thinking
3219
32203237 - `ToolUseBlock object`
32213238
3239 - `type: "tool_use"`
3240
3241 default: tool_use
3242
32223243 - `id: string`
32233244
32243245 pattern: ^[a-zA-Z0-9_-]+$
from line 3260
32393260
32403261 Tool invocation generated by a server-side tool.
32413262
3263 - `type: "code_execution_20250825"`
3264
32423265 - `tool_id: string`
32433266
32443267 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
32453268
3246 - `type: "code_execution_20250825"`
3247
32483269 - `ServerToolCaller20260120 object`
32493270
3271 - `type: "code_execution_20260120"`
3272
32503273 - `tool_id: string`
32513274
32523275 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
32533276
3254 - `type: "code_execution_20260120"`
3255
32563277 - `input: map[unknown]`
32573278
32583279 - `name: string`
32593280
32603281 minLength: 1
32613282
3262 - `type: "tool_use"`
3263
3264 default: tool_use
3265
32663283 - `toolset_name: optional string or null`
32673284
32683285 For a toolset member tool_use, the toolset family.
from line 3288
32713288
32723289 - `ServerToolUseBlock object`
32733290
3291 - `type: "server_tool_use"`
3292
3293 default: server_tool_use
3294
32743295 - `id: string`
32753296
32763297 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
from line 3330
33093330
33103331 - `"tool_search_tool_bm25"`
33113332
3312 - `type: "server_tool_use"`
3313
3314 default: server_tool_use
3315
33163333 - `WebSearchToolResultBlock object`
33173334
3335 - `type: "web_search_tool_result"`
3336
3337 default: web_search_tool_result
3338
33183339 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
33193340
33203341 Tool invocation directly from the model.
from line 3356
33353356
33363357 - `WebSearchToolResultError object`
33373358
3359 - `type: "web_search_tool_result_error"`
3360
3361 default: web_search_tool_result_error
3362
33383363 - `error_code: WebSearchToolResultErrorCode`
33393364
33403365 - `"invalid_tool_input"`
from line 3374
33493374
33503375 - `"request_too_large"`
33513376
3352 - `type: "web_search_tool_result_error"`
3353
3354 default: web_search_tool_result_error
3355
33563377 - `array of WebSearchResultBlock`
33573378
3379 - `type: "web_search_result"`
3380
3381 default: web_search_result
3382
33583383 - `encrypted_content: string`
33593384
33603385 - `page_age: string or null`
33613386
33623387 - `title: string`
33633388
3364 - `type: "web_search_result"`
3365
3366 default: web_search_result
3367
33683389 - `url: string`
33693390
33703391 - `tool_use_id: string`
33713392
33723393 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
33733394
3374 - `type: "web_search_tool_result"`
3375
3376 default: web_search_tool_result
3377
33783395 - `WebFetchToolResultBlock object`
33793396
3397 - `type: "web_fetch_tool_result"`
3398
3399 default: web_fetch_tool_result
3400
33803401 - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120`
33813402
33823403 Tool invocation directly from the model.
from line 3418
33973418
33983419 - `WebFetchToolResultErrorBlock object`
33993420
3421 - `type: "web_fetch_tool_result_error"`
3422
3423 default: web_fetch_tool_result_error
3424
34003425 - `error_code: WebFetchToolResultErrorCode`
34013426
34023427 - `"invalid_tool_input"`
from line 3442
34173442
34183443 - `"unavailable"`
34193444
3420 - `type: "web_fetch_tool_result_error"`
3421
3422 default: web_fetch_tool_result_error
3445 - `"content_too_large"`
34233446
34243447 - `WebFetchBlock object`
34253448
3449 - `type: "web_fetch_result"`
3450
3451 default: web_fetch_result
3452
34263453 - `content: DocumentBlock`
34273454
3455 - `type: "document"`
3456
3457 default: document
3458
34283459 - `citations: CitationsConfig or null`
34293460
34303461 Citation configuration for the document
from line 3468
34373468
34383469 - `Base64PDFSource object`
34393470
3471 - `type: "base64"`
3472
34403473 - `data: string`
34413474
34423475 format: byte
34433476
34443477 - `media_type: "application/pdf"`
34453478
3446 - `type: "base64"`
3447
34483479 - `PlainTextSource object`
34493480
3481 - `type: "text"`
3482
34503483 - `data: string`
34513484
34523485 - `media_type: "text/plain"`
34533486
3454 - `type: "text"`
3455
34563487 - `title: string or null`
34573488
34583489 The title of the document
34593490
3460 - `type: "document"`
3461
3462 default: document
3463
34643491 - `retrieved_at: string or null`
34653492
34663493 ISO 8601 timestamp when the content was retrieved
34673494
3468 - `type: "web_fetch_result"`
3469
3470 default: web_fetch_result
3471
34723495 - `url: string`
34733496
34743497 Fetched content URL
from line 3500
34773500
34783501 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
34793502
3480 - `type: "web_fetch_tool_result"`
3481
3482 default: web_fetch_tool_result
3483
34843503 - `CodeExecutionToolResultBlock object`
34853504
3505 - `type: "code_execution_tool_result"`
3506
3507 default: code_execution_tool_result
3508
34863509 - `content: CodeExecutionToolResultBlockContent`
34873510
34883511 Code execution result with encrypted stdout for PFC + web_search results.
34893512
34903513 - `CodeExecutionToolResultError object`
34913514
3515 - `type: "code_execution_tool_result_error"`
3516
3517 default: code_execution_tool_result_error
3518
34923519 - `error_code: CodeExecutionToolResultErrorCode`
34933520
34943521 - `"invalid_tool_input"`
from line 3526
34993526
35003527 - `"execution_time_exceeded"`
35013528
3502 - `type: "code_execution_tool_result_error"`
3503
3504 default: code_execution_tool_result_error
3505
35063529 - `CodeExecutionResultBlock object`
35073530
3531 - `type: "code_execution_result"`
3532
3533 default: code_execution_result
3534
35083535 - `content: array of CodeExecutionOutputBlock`
35093536
3537 - `type: "code_execution_output"`
3538
3539 default: code_execution_output
3540
35103541 - `file_id: string`
35113542
3543 - `return_code: number`
3544
3545 - `stderr: string`
3546
3547 - `stdout: string`
3548
3549 - `EncryptedCodeExecutionResultBlock object`
3550
3551 Code execution result with encrypted stdout for PFC + web_search results.
3552
3553 - `type: "encrypted_code_execution_result"`
3554
3555 default: encrypted_code_execution_result
3556
3557 - `content: array of CodeExecutionOutputBlock`
3558
35123559 - `type: "code_execution_output"`
35133560
35143561 default: code_execution_output
35153562
3563 - `file_id: string`
3564
3565 - `encrypted_stdout: string`
3566
35163567 - `return_code: number`
35173568
35183569 - `stderr: string`
35193570
3571 - `tool_use_id: string`
3572
3573 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
3574
3575 - `BashCodeExecutionToolResultBlock object`
3576
3577 - `type: "bash_code_execution_tool_result"`
3578
3579 default: bash_code_execution_tool_result
3580
3581 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
3582
3583 - `BashCodeExecutionToolResultError object`
3584
3585 - `type: "bash_code_execution_tool_result_error"`
3586
3587 default: bash_code_execution_tool_result_error
3588
3589 - `error_code: BashCodeExecutionToolResultErrorCode`
3590
3591 - `"invalid_tool_input"`
3592
3593 - `"unavailable"`
3594
3595 - `"too_many_requests"`
3596
3597 - `"execution_time_exceeded"`
3598
3599 - `"output_file_too_large"`
3600
3601 - `BashCodeExecutionResultBlock object`
3602
3603 - `type: "bash_code_execution_result"`
3604
3605 default: bash_code_execution_result
3606
3607 - `content: array of BashCodeExecutionOutputBlock`
3608
3609 - `type: "bash_code_execution_output"`
3610
3611 default: bash_code_execution_output
3612
3613 - `file_id: string`
3614
3615 - `return_code: number`
3616
3617 - `stderr: string`
3618
35203619 - `stdout: string`
35213620
3522 - `type: "code_execution_result"`
3523
3524 default: code_execution_result
3525
3526 - `EncryptedCodeExecutionResultBlock object`
3527
3528 Code execution result with encrypted stdout for PFC + web_search results.
3529
3530 - `content: array of CodeExecutionOutputBlock`
3531
3532 - `file_id: string`
3533
3534 - `type: "code_execution_output"`
3535
3536 default: code_execution_output
3537
3538 - `encrypted_stdout: string`
3539
3540 - `return_code: number`
3541
3542 - `stderr: string`
3543
3544 - `type: "encrypted_code_execution_result"`
3545
3546 default: encrypted_code_execution_result
3547
35483621 - `tool_use_id: string`
35493622
35503623 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
35513624
3552 - `type: "code_execution_tool_result"`
3553
3554 default: code_execution_tool_result
3555
3556 - `BashCodeExecutionToolResultBlock object`
3557
3558 - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock`
3559
3560 - `BashCodeExecutionToolResultError object`
3561
3562 - `error_code: BashCodeExecutionToolResultErrorCode`
3625 - `TextEditorCodeExecutionToolResultBlock object`
3626
3627 - `type: "text_editor_code_execution_tool_result"`
3628
3629 default: text_editor_code_execution_tool_result
3630
3631 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
3632
3633 - `TextEditorCodeExecutionToolResultError object`
3634
3635 - `type: "text_editor_code_execution_tool_result_error"`
3636
3637 default: text_editor_code_execution_tool_result_error
3638
3639 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
35633640
35643641 - `"invalid_tool_input"`
35653642
from line 3646
35693646
35703647 - `"execution_time_exceeded"`
35713648
3572 - `"output_file_too_large"`
3573
3574 - `type: "bash_code_execution_tool_result_error"`
3575
3576 default: bash_code_execution_tool_result_error
3577
3578 - `BashCodeExecutionResultBlock object`
3579
3580 - `content: array of BashCodeExecutionOutputBlock`
3581
3582 - `file_id: string`
3583
3584 - `type: "bash_code_execution_output"`
3585
3586 default: bash_code_execution_output
3587
3588 - `return_code: number`
3589
3590 - `stderr: string`
3591
3592 - `stdout: string`
3593
3594 - `type: "bash_code_execution_result"`
3595
3596 default: bash_code_execution_result
3649 - `"file_not_found"`
3650
3651 - `error_message: string or null`
3652
3653 - `TextEditorCodeExecutionViewResultBlock object`
3654
3655 - `type: "text_editor_code_execution_view_result"`
3656
3657 default: text_editor_code_execution_view_result
3658
3659 - `content: string`
3660
3661 - `file_type: "text" or "image" or "pdf"`
3662
3663 - `"text"`
3664
3665 - `"image"`
3666
3667 - `"pdf"`
3668
3669 - `num_lines: number or null`
3670
3671 - `start_line: number or null`
3672
3673 - `total_lines: number or null`
3674
3675 - `TextEditorCodeExecutionCreateResultBlock object`
3676
3677 - `type: "text_editor_code_execution_create_result"`
3678
3679 default: text_editor_code_execution_create_result
3680
3681 - `is_file_update: boolean`
3682
3683 - `TextEditorCodeExecutionStrReplaceResultBlock object`
3684
3685 - `type: "text_editor_code_execution_str_replace_result"`
3686
3687 default: text_editor_code_execution_str_replace_result
3688
3689 - `lines: array of string or null`
3690
3691 - `new_lines: number or null`
3692
3693 - `new_start: number or null`
3694
3695 - `old_lines: number or null`
3696
3697 - `old_start: number or null`
35973698
35983699 - `tool_use_id: string`
35993700
36003701 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
36013702
3602 - `type: "bash_code_execution_tool_result"`
3603
3604 default: bash_code_execution_tool_result
3605
3606 - `TextEditorCodeExecutionToolResultBlock object`
3607
3608 - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock`
3609
3610 - `TextEditorCodeExecutionToolResultError object`
3611
3612 - `error_code: TextEditorCodeExecutionToolResultErrorCode`
3703 - `ToolSearchToolResultBlock object`
3704
3705 - `type: "tool_search_tool_result"`
3706
3707 default: tool_search_tool_result
3708
3709 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
3710
3711 - `ToolSearchToolResultError object`
3712
3713 - `type: "tool_search_tool_result_error"`
3714
3715 default: tool_search_tool_result_error
3716
3717 - `error_code: ToolSearchToolResultErrorCode`
36133718
36143719 - `"invalid_tool_input"`
36153720
from line 3724
36193724
36203725 - `"execution_time_exceeded"`
36213726
3622 - `"file_not_found"`
3623
36243727 - `error_message: string or null`
36253728
3626 - `type: "text_editor_code_execution_tool_result_error"`
3627
3628 default: text_editor_code_execution_tool_result_error
3629
3630 - `TextEditorCodeExecutionViewResultBlock object`
3631
3632 - `content: string`
3633
3634 - `file_type: "text" or "image" or "pdf"`
3635
3636 - `"text"`
3637
3638 - `"image"`
3639
3640 - `"pdf"`
3641
3642 - `num_lines: number or null`
3643
3644 - `start_line: number or null`
3645
3646 - `total_lines: number or null`
3647
3648 - `type: "text_editor_code_execution_view_result"`
3649
3650 default: text_editor_code_execution_view_result
3651
3652 - `TextEditorCodeExecutionCreateResultBlock object`
3653
3654 - `is_file_update: boolean`
3655
3656 - `type: "text_editor_code_execution_create_result"`
3657
3658 default: text_editor_code_execution_create_result
3659
3660 - `TextEditorCodeExecutionStrReplaceResultBlock object`
3661
3662 - `lines: array of string or null`
3663
3664 - `new_lines: number or null`
3665
3666 - `new_start: number or null`
3667
3668 - `old_lines: number or null`
3669
3670 - `old_start: number or null`
3671
3672 - `type: "text_editor_code_execution_str_replace_result"`
3673
3674 default: text_editor_code_execution_str_replace_result
3729 - `ToolSearchToolSearchResultBlock object`
3730
3731 - `type: "tool_search_tool_search_result"`
3732
3733 default: tool_search_tool_search_result
3734
3735 - `tool_references: array of ToolReferenceBlock`
3736
3737 - `type: "tool_reference"`
3738
3739 default: tool_reference
3740
3741 - `tool_name: string`
3742
3743 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
36753744
36763745 - `tool_use_id: string`
36773746
36783747 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
36793748
3680 - `type: "text_editor_code_execution_tool_result"`
3681
3682 default: text_editor_code_execution_tool_result
3683
3684 - `ToolSearchToolResultBlock object`
3685
3686 - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock`
3687
3688 - `ToolSearchToolResultError object`
3689
3690 - `error_code: ToolSearchToolResultErrorCode`
3691
3692 - `"invalid_tool_input"`
3693
3694 - `"unavailable"`
3695
3696 - `"too_many_requests"`
3697
3698 - `"execution_time_exceeded"`
3699
3700 - `error_message: string or null`
3701
3702 - `type: "tool_search_tool_result_error"`
3703
3704 default: tool_search_tool_result_error
3705
3706 - `ToolSearchToolSearchResultBlock object`
3707
3708 - `tool_references: array of ToolReferenceBlock`
3709
3710 - `tool_name: string`
3711
3712 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
3713
3714 - `type: "tool_reference"`
3715
3716 default: tool_reference
3717
3718 - `type: "tool_search_tool_search_result"`
3719
3720 default: tool_search_tool_search_result
3721
3722 - `tool_use_id: string`
3723
3724 pattern: ^srvtoolu_[a-zA-Z0-9_]+$
3725
3726 - `type: "tool_search_tool_result"`
3727
3728 default: tool_search_tool_result
3729
37303749 - `ContainerUploadBlock object`
37313750
37323751 Response model for a file uploaded to the container.
37333752
3753 - `type: "container_upload"`
3754
3755 default: container_upload
3756
37343757 - `file_id: string`
37353758
3736 - `type: "container_upload"`
3737
3738 default: container_upload
3739
37403759 - `model: Model`
37413760
37423761 The model that will complete your prompt.
from line 3850
38313850
38323851 Structured information about a refusal.
38333852
3853 - `type: "refusal"`
3854
3855 default: refusal
3856
38343857 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
38353858
38363859 The policy category that triggered a refusal.
from line 3883
38603883 Human-readable explanation of the refusal.
38613884
38623885 This text is not guaranteed to be stable. `null` when no explanation is available for the category.
3863
3864 - `type: "refusal"`
3865
3866 default: refusal
38673886
38683887 - `stop_reason: StopReason or null`
38693888
from line 3920
39013920
39023921 This value will be a non-null string if one of your custom stop sequences was generated.
39033922
3904 - `type: "message"`
3905
3906 Object type.
3907
3908 For Messages, this is always `"message"`.
3909
3910 default: message
3911
39123923 - `usage: Usage`
39133924
39143925 Billing and rate-limit usage.
from line 4028
40174028
40184029 - `RawMessageStartEvent object`
40194030
4031 - `type: "message_start"`
4032
4033 default: message_start
4034
40204035 - `message: Message`
40214036
4022 - `type: "message_start"`
4023
4024 default: message_start
4025
40264037 - `RawMessageDeltaEvent object`
40274038
4039 - `type: "message_delta"`
4040
4041 default: message_delta
4042
40284043 - `delta: object`
40294044
40304045 - `container: Container or null`
from line 4053
40384053 - `stop_reason: StopReason or null`
40394054
40404055 - `stop_sequence: string or null`
4041
4042 - `type: "message_delta"`
4043
4044 default: message_delta
40454056
40464057 - `usage: MessageDeltaUsage`
40474058
from line 4109
40984109
40994110 - `RawContentBlockStartEvent object`
41004111
4112 - `type: "content_block_start"`
4113
4114 default: content_block_start
4115
41014116 - `content_block: TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more`
41024117
41034118 Response model for a file uploaded to the container.
from line 4145
41304145
41314146 - `index: number`
41324147
4133 - `type: "content_block_start"`
4134
4135 default: content_block_start
4136
41374148 - `RawContentBlockDeltaEvent object`
41384149
4150 - `type: "content_block_delta"`
4151
4152 default: content_block_delta
4153
41394154 - `delta: RawContentBlockDelta`
41404155
41414156 - `TextDelta object`
41424157
4158 - `type: "text_delta"`
4159
4160 default: text_delta
4161
41434162 - `text: string`
41444163
4145 - `type: "text_delta"`
4146
4147 default: text_delta
4148
41494164 - `InputJSONDelta object`
41504165
4166 - `type: "input_json_delta"`
4167
4168 default: input_json_delta
4169
41514170 - `partial_json: string`
41524171
4153 - `type: "input_json_delta"`
4154
4155 default: input_json_delta
4156
41574172 - `CitationsDelta object`
41584173
4174 - `type: "citations_delta"`
4175
4176 default: citations_delta
4177
41594178 - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more`
41604179
41614180 - `CitationCharLocation object`
from line 4187
41684187
41694188 - `CitationsSearchResultLocation object`
41704189
4171 - `type: "citations_delta"`
4172
4173 default: citations_delta
4174
41754190 - `ThinkingDelta object`
41764191
4192 - `type: "thinking_delta"`
4193
4194 default: thinking_delta
4195
41774196 - `thinking: string`
41784197
41794198 The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value.
41804199
4181 - `type: "thinking_delta"`
4182
4183 default: thinking_delta
4184
41854200 - `SignatureDelta object`
41864201
4202 - `type: "signature_delta"`
4203
4204 default: signature_delta
4205
41874206 - `signature: string`
41884207
41894208 The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event.
41904209
4191 - `type: "signature_delta"`
4192
4193 default: signature_delta
4194
41954210 - `index: number`
41964211
4197 - `type: "content_block_delta"`
4198
4199 default: content_block_delta
4200
42014212 - `RawContentBlockStopEvent object`
42024213
4214 - `type: "content_block_stop"`
4215
4216 default: content_block_stop
4217
42034218 - `index: number`
4204
4205 - `type: "content_block_stop"`
4206
4207 default: content_block_stop
42084219
42094220## Example
42104221
42114222
api/models Changed · +39 / -26 lines
from line 1
1---
2title: Models
3url: https://platform.claude.com/docs/en/api/models
4---
5
16# Models
27
38## List Models
from line 39
3439
3540 - `string`
3641
37 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3843
3944 - `"message-batches-2024-09-24"`
4045
from line 87
8287
8388 - `"user-profiles-2026-08-18"`
8489
90 - `"user-profiles-2026-09-04"`
91
8592 - `"advisor-tool-2026-03-01"`
8693
8794 - `"managed-agents-2026-04-01"`
from line 131
124131
125132 - `"mid-conversation-system-clear-at-2026-08-21"`
126133
134- `"anthropic-workspace-id": optional string`
135
127136### Returns
128137
129138- `data: array of ModelInfo`
130139
140 - `type: "model"`
141
142 Object type.
143
144 For Models, this is always `"model"`.
145
146 default: model
147
131148 - `id: string`
132149
133150 Unique model identifier.
from line 267
250267
251268 Maximum value for the `max_tokens` parameter when using this model.
252269
253 - `type: "model"`
254
255 Object type.
256
257 For Models, this is always `"model"`.
258
259 default: model
260
261270- `first_id: string or null`
262271
263272 First ID in the `data` list. Can be used as the `before_id` for the previous page.
from line 390
381390
382391 - `string`
383392
384 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
393 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
385394
386395 - `"message-batches-2024-09-24"`
387396
from line 438
429438
430439 - `"user-profiles-2026-08-18"`
431440
441 - `"user-profiles-2026-09-04"`
442
432443 - `"advisor-tool-2026-03-01"`
433444
434445 - `"managed-agents-2026-04-01"`
from line 482
471482
472483 - `"mid-conversation-system-clear-at-2026-08-21"`
473484
485- `"anthropic-workspace-id": optional string`
486
474487### Returns
475488
476489- `ModelInfo object`
477490
491 - `type: "model"`
492
493 Object type.
494
495 For Models, this is always `"model"`.
496
497 default: model
498
478499 - `id: string`
479500
480501 Unique model identifier.
from line 618
597618
598619 Maximum value for the `max_tokens` parameter when using this model.
599620
600 - `type: "model"`
601
602 Object type.
603
604 For Models, this is always `"model"`.
605
606 default: model
607
608621### Example
609622
610623```bash
from line 878
865878
866879- `ModelInfo object`
867880
881 - `type: "model"`
882
883 Object type.
884
885 For Models, this is always `"model"`.
886
887 default: model
888
868889 - `id: string`
869890
870891 Unique model identifier.
from line 1007
9861007 - `max_tokens: number or null`
9871008
9881009 Maximum value for the `max_tokens` parameter when using this model.
989
990 - `type: "model"`
991
992 Object type.
993
994 For Models, this is always `"model"`.
995
996 default: model
9971010
9981011### Thinking Capability
9991012
api/models/list Changed · +18 / -9 lines
from line 1
1---
2title: List Models
3url: https://platform.claude.com/docs/en/api/models/list
4---
5
16# List Models
27
38**GET** `/v1/models`
from line 37
3237
3338 - `string`
3439
35 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3641
3742 - `"message-batches-2024-09-24"`
3843
from line 85
8085
8186 - `"user-profiles-2026-08-18"`
8287
88 - `"user-profiles-2026-09-04"`
89
8390 - `"advisor-tool-2026-03-01"`
8491
8592 - `"managed-agents-2026-04-01"`
from line 129
122129
123130 - `"mid-conversation-system-clear-at-2026-08-21"`
124131
132- `"anthropic-workspace-id": optional string`
133
125134## Returns
126135
127136- `data: array of ModelInfo`
128137
138 - `type: "model"`
139
140 Object type.
141
142 For Models, this is always `"model"`.
143
144 default: model
145
129146 - `id: string`
130147
131148 Unique model identifier.
from line 264
247264 - `max_tokens: number or null`
248265
249266 Maximum value for the `max_tokens` parameter when using this model.
250
251 - `type: "model"`
252
253 Object type.
254
255 For Models, this is always `"model"`.
256
257 default: model
258267
259268- `first_id: string or null`
260269
api/models/retrieve Changed · +18 / -9 lines
from line 1
1---
2title: Get a Model
3url: https://platform.claude.com/docs/en/api/models/retrieve
4---
5
16# Get a Model
27
38**GET** `/v1/models/{model_id}`
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122## Returns
114123
115124- `ModelInfo object`
116125
126 - `type: "model"`
127
128 Object type.
129
130 For Models, this is always `"model"`.
131
132 default: model
133
117134 - `id: string`
118135
119136 Unique model identifier.
from line 252
235252 - `max_tokens: number or null`
236253
237254 Maximum value for the `max_tokens` parameter when using this model.
238
239 - `type: "model"`
240
241 Object type.
242
243 For Models, this is always `"model"`.
244
245 default: model
246255
247256## Example
248257