One read of Claude Developer Platformapi-20260925T153714Z
310 pages moved out of 637 read.
Pages moved
310
significant first
Pages read
637
in this capture
Captured
15:37 UTC
Corpus hash
850f99a0d461
corpus-hash
What this read moved
26-50 of 310, page 2 of 13This capture is too large to show at once. Changes 26-50 of 310 are below, significant first; the rest are on the following screens.
api/beta/dreams/list Changed · +9 / -11 lines
from line 203
203203
204204 - `archived_at: string or null`
205205
206 A timestamp in RFC 3339 format
206 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
207207
208208 format: date-time
209209
210210 - `created_at: string`
211211
212 A timestamp in RFC 3339 format
212 When the dream was created, in RFC 3339.
213213
214 Lists of dreams are sorted by this time, newest first.
215
214216 format: date-time
215217
216218 - `ended_at: string or null`
217219
218 A timestamp in RFC 3339 format
220 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
219221
220222 format: date-time
221223
222224 - `error: BetaDreamError or null`
223225
224 Failure detail for a Dream whose `status` is `failed`.
226 Why the dream failed, or `null` if `status` isn't `failed`.
225227
226228 - `type: string`
227229
from line 287
285287
286288 - `speed: optional "standard" or "fast"`
287289
288 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
290 How fast the model generates output for the dream. Always `standard`.
289291
290292 - `"standard"`
291293
from line 295
293295
294296 - `output_behavior: BetaOutputBehavior`
295297
296 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
298 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
297299
298300 - `BetaOutputBehaviorCreateNew object`
299301
from line 381
379381
380382 - `usage: BetaDreamUsage`
381383
382 The tokens that a dream has used so far.
383
384 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
385
386 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
384 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
387385
388386 - `cache_creation_input_tokens: number`
389387
api/beta/dreams/retrieve Changed · +9 / -11 lines
from line 151
151151
152152 - `archived_at: string or null`
153153
154 A timestamp in RFC 3339 format
154 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
155155
156156 format: date-time
157157
158158 - `created_at: string`
159159
160 A timestamp in RFC 3339 format
160 When the dream was created, in RFC 3339.
161161
162 Lists of dreams are sorted by this time, newest first.
163
162164 format: date-time
163165
164166 - `ended_at: string or null`
165167
166 A timestamp in RFC 3339 format
168 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
167169
168170 format: date-time
169171
170172 - `error: BetaDreamError or null`
171173
172 Failure detail for a Dream whose `status` is `failed`.
174 Why the dream failed, or `null` if `status` isn't `failed`.
173175
174176 - `type: string`
175177
from line 235
233235
234236 - `speed: optional "standard" or "fast"`
235237
236 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
238 How fast the model generates output for the dream. Always `standard`.
237239
238240 - `"standard"`
239241
from line 243
241243
242244 - `output_behavior: BetaOutputBehavior`
243245
244 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
246 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
245247
246248 - `BetaOutputBehaviorCreateNew object`
247249
from line 329
327329
328330 - `usage: BetaDreamUsage`
329331
330 The tokens that a dream has used so far.
331
332 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
333
334 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
332 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
335333
336334 - `cache_creation_input_tokens: number`
337335
api/beta/environments Changed · +7 / -19 lines
from line 129
129129
130130 Human-readable name for the environment
131131
132 maxLength: 256, minLength: 1
132 minLength: 1, maxLength: 256
133133
134134- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`
135135
from line 183
183183
184184 - `packages: optional BetaPackagesParams or null`
185185
186 Specify packages (and optionally their versions) available in this environment.
186 Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value.
187187
188 When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
189
190 Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
191
192188 - `type: optional "packages"`
193189
194190 Package configuration type
from line 472
476472
477473 Maximum number of environments to return
478474
479 default: 20, maximum: 1000, minimum: 1
475 default: 20, minimum: 1, maximum: 1000
480476
481477- `page: optional string`
482478
from line 1281
12851281
12861282 - `packages: optional BetaPackagesParams or null`
12871283
1288 Specify packages (and optionally their versions) available in this environment.
1284 Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value.
12891285
1290 When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
1291
1292 Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
1293
12941286 - `type: optional "packages"`
12951287
12961288 Package configuration type
from line 1335
13431335
13441336 Updated name for the environment
13451337
1346 maxLength: 256, minLength: 1
1338 minLength: 1, maxLength: 256
13471339
13481340- `scope: optional "organization" or "account" or null`
13491341
from line 2141
21492141
21502142 - `packages: optional BetaPackagesParams or null`
21512143
2152 Specify packages (and optionally their versions) available in this environment.
2144 Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value.
21532145
2154 When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
2155
2156 Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
2157
21582146 - `type: optional "packages"`
21592147
21602148 Package configuration type
from line 3669
36813669
36823670 Maximum number of work items to return
36833671
3684 default: 20, maximum: 1000, minimum: 1
3672 default: 20, minimum: 1, maximum: 1000
36853673
36863674- `page: optional string`
36873675
api/beta/environments/create Changed · +2 / -6 lines
from line 127
127127
128128 Human-readable name for the environment
129129
130 maxLength: 256, minLength: 1
130 minLength: 1, maxLength: 256
131131
132132- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`
133133
from line 181
181181
182182 - `packages: optional BetaPackagesParams or null`
183183
184 Specify packages (and optionally their versions) available in this environment.
185
186 When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
187
188 Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
184 Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value.
189185
190186 - `type: optional "packages"`
191187
api/beta/environments/update Changed · +2 / -6 lines
from line 179
179179
180180 - `packages: optional BetaPackagesParams or null`
181181
182 Specify packages (and optionally their versions) available in this environment.
182 Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value.
183183
184 When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
185
186 Under `limited` networking, requires `networking.allow_package_managers` to be `true`.
187
188184 - `type: optional "packages"`
189185
190186 Package configuration type
from line 233
237233
238234 Updated name for the environment
239235
240 maxLength: 256, minLength: 1
236 minLength: 1, maxLength: 256
241237
242238- `scope: optional "organization" or "account" or null`
243239
api/beta/files Changed · +9 / -9 lines
from line 163
163163
164164 Original filename of the uploaded file.
165165
166 maxLength: 500, minLength: 1
166 minLength: 1, maxLength: 500
167167
168168 - `mime_type: string`
169169
170170 MIME type of the file.
171171
172 maxLength: 255, minLength: 1
172 minLength: 1, maxLength: 255
173173
174174 - `size_bytes: number`
175175
from line 248
248248
249249 Defaults to `20`. Ranges from `1` to `1000`.
250250
251 default: 20, maximum: 1000, minimum: 1
251 default: 20, minimum: 1, maximum: 1000
252252
253253- `page: optional string`
254254
from line 398
398398
399399 Original filename of the uploaded file.
400400
401 maxLength: 500, minLength: 1
401 minLength: 1, maxLength: 500
402402
403403 - `mime_type: string`
404404
405405 MIME type of the file.
406406
407 maxLength: 255, minLength: 1
407 minLength: 1, maxLength: 255
408408
409409 - `size_bytes: number`
410410
from line 754
754754
755755 Original filename of the uploaded file.
756756
757 maxLength: 500, minLength: 1
757 minLength: 1, maxLength: 500
758758
759759 - `mime_type: string`
760760
761761 MIME type of the file.
762762
763 maxLength: 255, minLength: 1
763 minLength: 1, maxLength: 255
764764
765765 - `size_bytes: number`
766766
from line 1021
10211021
10221022 Original filename of the uploaded file.
10231023
1024 maxLength: 500, minLength: 1
1024 minLength: 1, maxLength: 500
10251025
10261026 - `mime_type: string`
10271027
10281028 MIME type of the file.
10291029
1030 maxLength: 255, minLength: 1
1030 minLength: 1, maxLength: 255
10311031
10321032 - `size_bytes: number`
10331033
api/beta/files/list Changed · +3 / -3 lines
from line 21
2121
2222 Defaults to `20`. Ranges from `1` to `1000`.
2323
24 default: 20, maximum: 1000, minimum: 1
24 default: 20, minimum: 1, maximum: 1000
2525
2626- `page: optional string`
2727
from line 171
171171
172172 Original filename of the uploaded file.
173173
174 maxLength: 500, minLength: 1
174 minLength: 1, maxLength: 500
175175
176176 - `mime_type: string`
177177
178178 MIME type of the file.
179179
180 maxLength: 255, minLength: 1
180 minLength: 1, maxLength: 255
181181
182182 - `size_bytes: number`
183183
api/beta/memory_stores Changed · +42 / -42 lines
from line 155
155155
156156 - `created_at: string`
157157
158 A timestamp in RFC 3339 format
158 Timestamp when the store was created.
159159
160160 format: date-time
161161
from line 165
165165
166166 - `updated_at: string`
167167
168 A timestamp in RFC 3339 format
168 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
169169
170170 format: date-time
171171
172172 - `archived_at: optional string or null`
173173
174 A timestamp in RFC 3339 format
174 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
175175
176176 format: date-time
177177
from line 373
373373
374374 - `created_at: string`
375375
376 A timestamp in RFC 3339 format
376 Timestamp when the store was created.
377377
378378 format: date-time
379379
from line 383
383383
384384 - `updated_at: string`
385385
386 A timestamp in RFC 3339 format
386 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
387387
388388 format: date-time
389389
390390 - `archived_at: optional string or null`
391391
392 A timestamp in RFC 3339 format
392 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
393393
394394 format: date-time
395395
from line 574
574574
575575 - `created_at: string`
576576
577 A timestamp in RFC 3339 format
577 Timestamp when the store was created.
578578
579579 format: date-time
580580
from line 584
584584
585585 - `updated_at: string`
586586
587 A timestamp in RFC 3339 format
587 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
588588
589589 format: date-time
590590
591591 - `archived_at: optional string or null`
592592
593 A timestamp in RFC 3339 format
593 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
594594
595595 format: date-time
596596
from line 784
784784
785785 - `created_at: string`
786786
787 A timestamp in RFC 3339 format
787 Timestamp when the store was created.
788788
789789 format: date-time
790790
from line 794
794794
795795 - `updated_at: string`
796796
797 A timestamp in RFC 3339 format
797 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
798798
799799 format: date-time
800800
801801 - `archived_at: optional string or null`
802802
803 A timestamp in RFC 3339 format
803 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
804804
805805 format: date-time
806806
from line 1133
11331133
11341134 - `created_at: string`
11351135
1136 A timestamp in RFC 3339 format
1136 Timestamp when the store was created.
11371137
11381138 format: date-time
11391139
from line 1143
11431143
11441144 - `updated_at: string`
11451145
1146 A timestamp in RFC 3339 format
1146 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
11471147
11481148 format: date-time
11491149
11501150 - `archived_at: optional string or null`
11511151
1152 A timestamp in RFC 3339 format
1152 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
11531153
11541154 format: date-time
11551155
from line 1216
12161216
12171217 - `created_at: string`
12181218
1219 A timestamp in RFC 3339 format
1219 Timestamp when the store was created.
12201220
12211221 format: date-time
12221222
from line 1226
12261226
12271227 - `updated_at: string`
12281228
1229 A timestamp in RFC 3339 format
1229 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
12301230
12311231 format: date-time
12321232
12331233 - `archived_at: optional string or null`
12341234
1235 A timestamp in RFC 3339 format
1235 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
12361236
12371237 format: date-time
12381238
from line 1420
14201420
14211421 - `created_at: string`
14221422
1423 A timestamp in RFC 3339 format
1423 When this memory was created, in RFC 3339 format.
14241424
14251425 format: date-time
14261426
from line 1438
14381438
14391439 - `updated_at: string`
14401440
1441 A timestamp in RFC 3339 format
1441 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
14421442
14431443 format: date-time
14441444
from line 1663
16631663
16641664 - `created_at: string`
16651665
1666 A timestamp in RFC 3339 format
1666 When this memory was created, in RFC 3339 format.
16671667
16681668 format: date-time
16691669
from line 1681
16811681
16821682 - `updated_at: string`
16831683
1684 A timestamp in RFC 3339 format
1684 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
16851685
16861686 format: date-time
16871687
from line 1900
19001900
19011901 - `created_at: string`
19021902
1903 A timestamp in RFC 3339 format
1903 When this memory was created, in RFC 3339 format.
19041904
19051905 format: date-time
19061906
from line 1918
19181918
19191919 - `updated_at: string`
19201920
1921 A timestamp in RFC 3339 format
1921 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
19221922
19231923 format: date-time
19241924
from line 2108
21082108
21092109- `precondition: optional BetaManagedAgentsPrecondition`
21102110
2111 Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409.
2111 Optional optimistic-concurrency precondition. When supplied, the update applies only if the memory's current state matches; on mismatch the request returns `memory_precondition_failed_error` (HTTP 409). When omitted, the update is unconditional.
21122112
21132113 - `type: "content_sha256"`
21142114
from line 2140
21402140
21412141 - `created_at: string`
21422142
2143 A timestamp in RFC 3339 format
2143 When this memory was created, in RFC 3339 format.
21442144
21452145 format: date-time
21462146
from line 2158
21582158
21592159 - `updated_at: string`
21602160
2161 A timestamp in RFC 3339 format
2161 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
21622162
21632163 format: date-time
21642164
from line 2571
25712571
25722572 - `created_at: string`
25732573
2574 A timestamp in RFC 3339 format
2574 When this version was written, in RFC 3339 format.
25752575
25762576 format: date-time
25772577
from line 2585
25852585
25862586 - `operation: BetaManagedAgentsMemoryVersionOperation`
25872587
2588 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
2588 The kind of mutation this version records: `created`, `modified`, or `deleted`.
25892589
25902590 - `"created"`
25912591
from line 2615
26152615
26162616 - `created_by: optional BetaManagedAgentsActor`
26172617
2618 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
2618 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
26192619
26202620 - `BetaManagedAgentsSessionActor object`
26212621
from line 2671
26712671
26722672 - `redacted_at: optional string or null`
26732673
2674 A timestamp in RFC 3339 format
2674 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
26752675
26762676 format: date-time
26772677
26782678 - `redacted_by: optional BetaManagedAgentsActor`
26792679
2680 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
2680 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
26812681
26822682- `next_page: optional string or null`
26832683
from line 2879
28792879
28802880 - `created_at: string`
28812881
2882 A timestamp in RFC 3339 format
2882 When this version was written, in RFC 3339 format.
28832883
28842884 format: date-time
28852885
from line 2893
28932893
28942894 - `operation: BetaManagedAgentsMemoryVersionOperation`
28952895
2896 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
2896 The kind of mutation this version records: `created`, `modified`, or `deleted`.
28972897
28982898 - `"created"`
28992899
from line 2923
29232923
29242924 - `created_by: optional BetaManagedAgentsActor`
29252925
2926 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
2926 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
29272927
29282928 - `BetaManagedAgentsSessionActor object`
29292929
from line 2979
29792979
29802980 - `redacted_at: optional string or null`
29812981
2982 A timestamp in RFC 3339 format
2982 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
29832983
29842984 format: date-time
29852985
29862986 - `redacted_by: optional BetaManagedAgentsActor`
29872987
2988 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
2988 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
29892989
29902990#### Example
29912991
from line 3164
31643164
31653165 - `created_at: string`
31663166
3167 A timestamp in RFC 3339 format
3167 When this version was written, in RFC 3339 format.
31683168
31693169 format: date-time
31703170
from line 3178
31783178
31793179 - `operation: BetaManagedAgentsMemoryVersionOperation`
31803180
3181 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
3181 The kind of mutation this version records: `created`, `modified`, or `deleted`.
31823182
31833183 - `"created"`
31843184
from line 3208
32083208
32093209 - `created_by: optional BetaManagedAgentsActor`
32103210
3211 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
3211 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
32123212
32133213 - `BetaManagedAgentsSessionActor object`
32143214
from line 3264
32643264
32653265 - `redacted_at: optional string or null`
32663266
3267 A timestamp in RFC 3339 format
3267 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
32683268
32693269 format: date-time
32703270
32713271 - `redacted_by: optional BetaManagedAgentsActor`
32723272
3273 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
3273 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
32743274
32753275#### Example
32763276
api/beta/memory_stores/archive Changed · +3 / -3 lines
from line 141
141141
142142 - `created_at: string`
143143
144 A timestamp in RFC 3339 format
144 Timestamp when the store was created.
145145
146146 format: date-time
147147
from line 151
151151
152152 - `updated_at: string`
153153
154 A timestamp in RFC 3339 format
154 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
155155
156156 format: date-time
157157
158158 - `archived_at: optional string or null`
159159
160 A timestamp in RFC 3339 format
160 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
161161
162162 format: date-time
163163
api/beta/memory_stores/create Changed · +3 / -3 lines
from line 153
153153
154154 - `created_at: string`
155155
156 A timestamp in RFC 3339 format
156 Timestamp when the store was created.
157157
158158 format: date-time
159159
from line 163
163163
164164 - `updated_at: string`
165165
166 A timestamp in RFC 3339 format
166 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
167167
168168 format: date-time
169169
170170 - `archived_at: optional string or null`
171171
172 A timestamp in RFC 3339 format
172 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
173173
174174 format: date-time
175175
api/beta/memory_stores/list Changed · +3 / -3 lines
from line 163
163163
164164 - `created_at: string`
165165
166 A timestamp in RFC 3339 format
166 Timestamp when the store was created.
167167
168168 format: date-time
169169
from line 173
173173
174174 - `updated_at: string`
175175
176 A timestamp in RFC 3339 format
176 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
177177
178178 format: date-time
179179
180180 - `archived_at: optional string or null`
181181
182 A timestamp in RFC 3339 format
182 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
183183
184184 format: date-time
185185
api/beta/memory_stores/memories Changed · +14 / -14 lines
from line 179
179179
180180 - `created_at: string`
181181
182 A timestamp in RFC 3339 format
182 When this memory was created, in RFC 3339 format.
183183
184184 format: date-time
185185
from line 197
197197
198198 - `updated_at: string`
199199
200 A timestamp in RFC 3339 format
200 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
201201
202202 format: date-time
203203
from line 422
422422
423423 - `created_at: string`
424424
425 A timestamp in RFC 3339 format
425 When this memory was created, in RFC 3339 format.
426426
427427 format: date-time
428428
from line 440
440440
441441 - `updated_at: string`
442442
443 A timestamp in RFC 3339 format
443 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
444444
445445 format: date-time
446446
from line 659
659659
660660 - `created_at: string`
661661
662 A timestamp in RFC 3339 format
662 When this memory was created, in RFC 3339 format.
663663
664664 format: date-time
665665
from line 677
677677
678678 - `updated_at: string`
679679
680 A timestamp in RFC 3339 format
680 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
681681
682682 format: date-time
683683
from line 867
867867
868868- `precondition: optional BetaManagedAgentsPrecondition`
869869
870 Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409.
870 Optional optimistic-concurrency precondition. When supplied, the update applies only if the memory's current state matches; on mismatch the request returns `memory_precondition_failed_error` (HTTP 409). When omitted, the update is unconditional.
871871
872872 - `type: "content_sha256"`
873873
from line 899
899899
900900 - `created_at: string`
901901
902 A timestamp in RFC 3339 format
902 When this memory was created, in RFC 3339 format.
903903
904904 format: date-time
905905
from line 917
917917
918918 - `updated_at: string`
919919
920 A timestamp in RFC 3339 format
920 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
921921
922922 format: date-time
923923
from line 1314
13141314
13151315 - `created_at: string`
13161316
1317 A timestamp in RFC 3339 format
1317 When this memory was created, in RFC 3339 format.
13181318
13191319 format: date-time
13201320
from line 1332
13321332
13331333 - `updated_at: string`
13341334
1335 A timestamp in RFC 3339 format
1335 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
13361336
13371337 format: date-time
13381338
from line 1368
13681368
13691369 - `created_at: string`
13701370
1371 A timestamp in RFC 3339 format
1371 When this memory was created, in RFC 3339 format.
13721372
13731373 format: date-time
13741374
from line 1386
13861386
13871387 - `updated_at: string`
13881388
1389 A timestamp in RFC 3339 format
1389 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
13901390
13911391 format: date-time
13921392
from line 1474
14741474
14751475- `BetaManagedAgentsPrecondition object`
14761476
1477 Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409.
1477 Optional condition that must hold for an update to apply. When omitted, the update is unconditional. Asserts the current state of the memory being updated. When an update changes `path`, the precondition still refers to the memory's current content, not the destination path. Currently the only supported variant is `content_sha256`.
14781478
14791479 - `type: "content_sha256"`
14801480
api/beta/memory_stores/memories/update Changed · +3 / -3 lines
from line 159
159159
160160- `precondition: optional BetaManagedAgentsPrecondition`
161161
162 Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409.
162 Optional optimistic-concurrency precondition. When supplied, the update applies only if the memory's current state matches; on mismatch the request returns `memory_precondition_failed_error` (HTTP 409). When omitted, the update is unconditional.
163163
164164 - `type: "content_sha256"`
165165
from line 191
191191
192192 - `created_at: string`
193193
194 A timestamp in RFC 3339 format
194 When this memory was created, in RFC 3339 format.
195195
196196 format: date-time
197197
from line 209
209209
210210 - `updated_at: string`
211211
212 A timestamp in RFC 3339 format
212 When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list).
213213
214214 format: date-time
215215
api/beta/memory_stores/memory_versions Changed · +20 / -20 lines
from line 213
213213
214214 - `created_at: string`
215215
216 A timestamp in RFC 3339 format
216 When this version was written, in RFC 3339 format.
217217
218218 format: date-time
219219
from line 227
227227
228228 - `operation: BetaManagedAgentsMemoryVersionOperation`
229229
230 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
230 The kind of mutation this version records: `created`, `modified`, or `deleted`.
231231
232232 - `"created"`
233233
from line 257
257257
258258 - `created_by: optional BetaManagedAgentsActor`
259259
260 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
260 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
261261
262262 - `BetaManagedAgentsSessionActor object`
263263
from line 313
313313
314314 - `redacted_at: optional string or null`
315315
316 A timestamp in RFC 3339 format
316 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
317317
318318 format: date-time
319319
320320 - `redacted_by: optional BetaManagedAgentsActor`
321321
322 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
322 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
323323
324324- `next_page: optional string or null`
325325
from line 521
521521
522522 - `created_at: string`
523523
524 A timestamp in RFC 3339 format
524 When this version was written, in RFC 3339 format.
525525
526526 format: date-time
527527
from line 535
535535
536536 - `operation: BetaManagedAgentsMemoryVersionOperation`
537537
538 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
538 The kind of mutation this version records: `created`, `modified`, or `deleted`.
539539
540540 - `"created"`
541541
from line 565
565565
566566 - `created_by: optional BetaManagedAgentsActor`
567567
568 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
568 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
569569
570570 - `BetaManagedAgentsSessionActor object`
571571
from line 621
621621
622622 - `redacted_at: optional string or null`
623623
624 A timestamp in RFC 3339 format
624 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
625625
626626 format: date-time
627627
628628 - `redacted_by: optional BetaManagedAgentsActor`
629629
630 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
630 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
631631
632632### Example
633633
from line 806
806806
807807 - `created_at: string`
808808
809 A timestamp in RFC 3339 format
809 When this version was written, in RFC 3339 format.
810810
811811 format: date-time
812812
from line 820
820820
821821 - `operation: BetaManagedAgentsMemoryVersionOperation`
822822
823 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
823 The kind of mutation this version records: `created`, `modified`, or `deleted`.
824824
825825 - `"created"`
826826
from line 850
850850
851851 - `created_by: optional BetaManagedAgentsActor`
852852
853 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
853 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
854854
855855 - `BetaManagedAgentsSessionActor object`
856856
from line 906
906906
907907 - `redacted_at: optional string or null`
908908
909 A timestamp in RFC 3339 format
909 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
910910
911911 format: date-time
912912
913913 - `redacted_by: optional BetaManagedAgentsActor`
914914
915 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
915 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
916916
917917### Example
918918
from line 1034
10341034
10351035 - `created_at: string`
10361036
1037 A timestamp in RFC 3339 format
1037 When this version was written, in RFC 3339 format.
10381038
10391039 format: date-time
10401040
from line 1048
10481048
10491049 - `operation: BetaManagedAgentsMemoryVersionOperation`
10501050
1051 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
1051 The kind of mutation this version records: `created`, `modified`, or `deleted`.
10521052
10531053 - `"created"`
10541054
from line 1078
10781078
10791079 - `created_by: optional BetaManagedAgentsActor`
10801080
1081 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
1081 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
10821082
10831083 - `BetaManagedAgentsSessionActor object`
10841084
from line 1134
11341134
11351135 - `redacted_at: optional string or null`
11361136
1137 A timestamp in RFC 3339 format
1137 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
11381138
11391139 format: date-time
11401140
11411141 - `redacted_by: optional BetaManagedAgentsActor`
11421142
1143 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
1143 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
11441144
11451145### Beta Managed Agents Memory Version Operation
11461146
api/beta/memory_stores/memory_versions/list Changed · +5 / -5 lines
from line 211
211211
212212 - `created_at: string`
213213
214 A timestamp in RFC 3339 format
214 When this version was written, in RFC 3339 format.
215215
216216 format: date-time
217217
from line 225
225225
226226 - `operation: BetaManagedAgentsMemoryVersionOperation`
227227
228 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
228 The kind of mutation this version records: `created`, `modified`, or `deleted`.
229229
230230 - `"created"`
231231
from line 255
255255
256256 - `created_by: optional BetaManagedAgentsActor`
257257
258 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
258 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
259259
260260 - `BetaManagedAgentsSessionActor object`
261261
from line 311
311311
312312 - `redacted_at: optional string or null`
313313
314 A timestamp in RFC 3339 format
314 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
315315
316316 format: date-time
317317
318318 - `redacted_by: optional BetaManagedAgentsActor`
319319
320 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
320 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
321321
322322- `next_page: optional string or null`
323323
api/beta/memory_stores/memory_versions/redact Changed · +5 / -5 lines
from line 145
145145
146146 - `created_at: string`
147147
148 A timestamp in RFC 3339 format
148 When this version was written, in RFC 3339 format.
149149
150150 format: date-time
151151
from line 159
159159
160160 - `operation: BetaManagedAgentsMemoryVersionOperation`
161161
162 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
162 The kind of mutation this version records: `created`, `modified`, or `deleted`.
163163
164164 - `"created"`
165165
from line 189
189189
190190 - `created_by: optional BetaManagedAgentsActor`
191191
192 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
192 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
193193
194194 - `BetaManagedAgentsSessionActor object`
195195
from line 245
245245
246246 - `redacted_at: optional string or null`
247247
248 A timestamp in RFC 3339 format
248 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
249249
250250 format: date-time
251251
252252 - `redacted_by: optional BetaManagedAgentsActor`
253253
254 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
254 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
255255
256256## Example
257257
api/beta/memory_stores/memory_versions/retrieve Changed · +5 / -5 lines
from line 159
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 When this version was written, in RFC 3339 format.
163163
164164 format: date-time
165165
from line 173
173173
174174 - `operation: BetaManagedAgentsMemoryVersionOperation`
175175
176 The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values.
176 The kind of mutation this version records: `created`, `modified`, or `deleted`.
177177
178178 - `"created"`
179179
from line 203
203203
204204 - `created_by: optional BetaManagedAgentsActor`
205205
206 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
206 Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](/docs/en/api/beta/sessions/retrieve).
207207
208208 - `BetaManagedAgentsSessionActor object`
209209
from line 259
259259
260260 - `redacted_at: optional string or null`
261261
262 A timestamp in RFC 3339 format
262 When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](/docs/en/api/beta/memory_stores/memory_versions/redact).
263263
264264 format: date-time
265265
266266 - `redacted_by: optional BetaManagedAgentsActor`
267267
268 Identifies who performed an operation. Recorded when the operation happens and not updated afterwards, so the ID may refer to a user, service account, API key, or session that has since been deleted.
268 Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability).
269269
270270## Example
271271
api/beta/memory_stores/retrieve Changed · +3 / -3 lines
from line 141
141141
142142 - `created_at: string`
143143
144 A timestamp in RFC 3339 format
144 Timestamp when the store was created.
145145
146146 format: date-time
147147
from line 151
151151
152152 - `updated_at: string`
153153
154 A timestamp in RFC 3339 format
154 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
155155
156156 format: date-time
157157
158158 - `archived_at: optional string or null`
159159
160 A timestamp in RFC 3339 format
160 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
161161
162162 format: date-time
163163
api/beta/memory_stores/update Changed · +3 / -3 lines
from line 159
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 Timestamp when the store was created.
163163
164164 format: date-time
165165
from line 169
169169
170170 - `updated_at: string`
171171
172 A timestamp in RFC 3339 format
172 Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this.
173173
174174 format: date-time
175175
176176 - `archived_at: optional string or null`
177177
178 A timestamp in RFC 3339 format
178 Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions.
179179
180180 format: date-time
181181
api/beta/messages Changed · +2282 / -2862 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.
from line 245
245245
246246 - `document_title: string or null`
247247
248 maxLength: 500, minLength: 1
248 minLength: 1, maxLength: 500
249249
250250 - `end_char_index: number`
251251
from line 265
265265
266266 - `document_title: string or null`
267267
268 maxLength: 500, minLength: 1
268 minLength: 1, maxLength: 500
269269
270270 - `end_page_number: number`
271271
from line 289
289289
290290 - `document_title: string or null`
291291
292 maxLength: 500, minLength: 1
292 minLength: 1, maxLength: 500
293293
294294 - `end_block_index: number`
295295
from line 313
313313
314314 - `title: string or null`
315315
316 maxLength: 512, minLength: 1
316 minLength: 1, maxLength: 512
317317
318318 - `url: string`
319319
from line 469
469469
470470 - `title: optional string or null`
471471
472 maxLength: 500, minLength: 1
472 minLength: 1, maxLength: 500
473473
474474 - `BetaSearchResultBlockParam object`
475475
from line 533
533533
534534 - `name: string`
535535
536 maxLength: 200, minLength: 1
536 minLength: 1, maxLength: 200
537537
538538 - `cache_control: optional BetaCacheControlEphemeral or null`
539539
from line 569
569569
570570 For a toolset member tool_use, the toolset family this member belongs to.
571571
572 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
572 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
573573
574574 - `BetaToolResultBlockParam object`
575575
from line 605
605605
606606 - `tool_name: string`
607607
608 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
608 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
609609
610610 - `cache_control: optional BetaCacheControlEphemeral or null`
611611
from line 633
633633
634634 The caller-assigned identifier for this tab, unique within the inventory.
635635
636 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
636 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
637637
638638 - `title: string`
639639
from line 659
659659
660660 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
661661
662 maxItems: 200, minItems: 1
662 minItems: 1, maxItems: 200
663663
664664 - `BetaBrowserStateChangeTabOpened object`
665665
from line 677
677677
678678 The `tab_id` of the opened tab, present in `tabs`.
679679
680 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
680 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
681681
682682 - `BetaBrowserStateChangeDownloadStarted object`
683683
from line 689
689689
690690 The caller-assigned identifier for this download, stable across the state changes reporting it.
691691
692 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
692 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
693693
694694 - `url: string`
695695
from line 710
710710
711711 The caller-assigned identifier for this download, stable across the state changes reporting it.
712712
713 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
713 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
714714
715715 - `url: string`
716716
from line 722
722722
723723 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
724724
725 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
725 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
726726
727727 - `size_bytes: optional number or null`
728728
from line 740
740740
741741 The caller-assigned identifier for this download, stable across the state changes reporting it.
742742
743 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
743 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
744744
745745 - `url: string`
746746
from line 752
752752
753753 The failure or cancellation detail, when known.
754754
755 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
755 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
756756
757757 - `is_error: optional boolean`
758758
from line 760
760760
761761 For a toolset member tool_result, the toolset family of the paired tool_use.
762762
763 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
763 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
764764
765765 - `BetaServerToolUseBlockParam object`
766766
from line 1192
11921192
11931193 - `tool_name: string`
11941194
1195 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1195 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
11961196
11971197 - `cache_control: optional BetaCacheControlEphemeral or null`
11981198
from line 1384
13841384
13851385 This is how the tool will be called by the model and in `tool_use` blocks.
13861386
1387 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1387 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
13881388
13891389 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
13901390
from line 1635
16351635
16361636 - `configs: optional BetaBrowserToolsetConfigs or null`
16371637
1638 Per-member configuration for `browser_toolset_20260801`: one
1639 optional field per member tool, keyed by the member name — the same
1640 name the member's `tool_use` blocks carry. Every member is an
1641 accepted key, and a member's defaults apply wherever its key is
1642 absent. Unknown keys are rejected: the field set is this toolset
1643 version's complete member set.
1638 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
16441639
16451640 - `type: optional BetaBrowserTypeConfig or null`
16461641
from line 2256
22612256
22622257 - `configs: optional BetaComputerToolsetConfigs or null`
22632258
2264 Per-member configuration for `computer_toolset_20260801`: one
2265 optional field per member tool, keyed by the member name — the same
2266 name the member's `tool_use` blocks carry. Every member is an
2267 accepted key, and a member's defaults apply wherever its key is
2268 absent. Unknown keys are rejected: the field set is this toolset
2269 version's complete member set.
2259 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
22702260
22712261 - `type: optional BetaComputerTypeConfig or null`
22722262
from line 2610
26202610
26212611 Maximum number of times the tool can be used in the API request.
26222612
2623 exclusiveMinimum: 0
2613 minimum: 1
26242614
26252615 - `strict: optional boolean`
26262616
from line 2626
26362626
26372627 The city of the user.
26382628
2639 maxLength: 255, minLength: 1
2629 minLength: 1, maxLength: 255
26402630
26412631 - `country: optional string or null`
26422632
26432633 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
26442634
2645 maxLength: 2, minLength: 2
2635 minLength: 2, maxLength: 2
26462636
26472637 - `region: optional string or null`
26482638
26492639 The region of the user.
26502640
2651 maxLength: 255, minLength: 1
2641 minLength: 1, maxLength: 255
26522642
26532643 - `timezone: optional string or null`
26542644
26552645 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
26562646
2657 maxLength: 255, minLength: 1
2647 minLength: 1, maxLength: 255
26582648
26592649 - `BetaWebFetchTool20250910 object`
26602650
from line 2690
27002690
27012691 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
27022692
2703 exclusiveMinimum: 0
2693 minimum: 1
27042694
27052695 - `max_uses: optional number or null`
27062696
27072697 Maximum number of times the tool can be used in the API request.
27082698
2709 exclusiveMinimum: 0
2699 minimum: 1
27102700
27112701 - `strict: optional boolean`
27122702
from line 2704
27142704
27152705 - `url_sources: optional BetaWebFetchURLSources or null`
27162706
2717 Which sources contribute to the set of URLs web fetch may fetch.
2707 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27182708
2719 Each key is a tagged variant: `user_input` is `all` or `none`; the
2720 two tool filters are `all`, `none`, `only` (only the named tools'
2721 results) or `except` (every result but the named tools'). A named tool
2722 must be declared in this request's `tools[]`.
2723
27242709 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
27252710
27262711 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2828
28432828
28442829 Maximum number of times the tool can be used in the API request.
28452830
2846 exclusiveMinimum: 0
2831 minimum: 1
28472832
28482833 - `strict: optional boolean`
28492834
from line 2882
28972882
28982883 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
28992884
2900 exclusiveMinimum: 0
2885 minimum: 1
29012886
29022887 - `max_uses: optional number or null`
29032888
29042889 Maximum number of times the tool can be used in the API request.
29052890
2906 exclusiveMinimum: 0
2891 minimum: 1
29072892
29082893 - `strict: optional boolean`
29092894
from line 2896
29112896
29122897 - `url_sources: optional BetaWebFetchURLSources or null`
29132898
2914 Which sources contribute to the set of URLs web fetch may fetch.
2899 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29152900
2916 Each key is a tagged variant: `user_input` is `all` or `none`; the
2917 two tool filters are `all`, `none`, `only` (only the named tools'
2918 results) or `except` (every result but the named tools'). A named tool
2919 must be declared in this request's `tools[]`.
2920
29212901 - `BetaWebFetchTool20260309 object`
29222902
29232903 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2944
29642944
29652945 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29662946
2967 exclusiveMinimum: 0
2947 minimum: 1
29682948
29692949 - `max_uses: optional number or null`
29702950
29712951 Maximum number of times the tool can be used in the API request.
29722952
2973 exclusiveMinimum: 0
2953 minimum: 1
29742954
29752955 - `strict: optional boolean`
29762956
from line 2958
29782958
29792959 - `url_sources: optional BetaWebFetchURLSources or null`
29802960
2981 Which sources contribute to the set of URLs web fetch may fetch.
2961 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29822962
2983 Each key is a tagged variant: `user_input` is `all` or `none`; the
2984 two tool filters are `all`, `none`, `only` (only the named tools'
2985 results) or `except` (every result but the named tools'). A named tool
2986 must be declared in this request's `tools[]`.
2987
29882963 - `use_cache: optional boolean`
29892964
29902965 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3004
30293004
30303005 Maximum number of times the tool can be used in the API request.
30313006
3032 exclusiveMinimum: 0
3007 minimum: 1
30333008
30343009 - `response_inclusion: optional "full" or "excluded"`
30353010
from line 3066
30913066
30923067 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
30933068
3094 exclusiveMinimum: 0
3069 minimum: 1
30953070
30963071 - `max_uses: optional number or null`
30973072
30983073 Maximum number of times the tool can be used in the API request.
30993074
3100 exclusiveMinimum: 0
3075 minimum: 1
31013076
31023077 - `response_inclusion: optional "full" or "excluded"`
31033078
from line 3088
31133088
31143089 - `url_sources: optional BetaWebFetchURLSources or null`
31153090
3116 Which sources contribute to the set of URLs web fetch may fetch.
3091 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
31173092
3118 Each key is a tagged variant: `user_input` is `all` or `none`; the
3119 two tool filters are `all`, `none`, `only` (only the named tools'
3120 results) or `except` (every result but the named tools'). A named tool
3121 must be declared in this request's `tools[]`.
3122
31233093 - `use_cache: optional boolean`
31243094
31253095 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3104
31343104
31353105 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31363106
3107 - `string`
3108
31373109 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
31383110
31393111 The model that will complete your prompt.
from line 3148
31763148
31773149 Powerful intelligence for long-running agents and coding
31783150
3179 - `"claude-mythos-preview"`
3180
3181 New class of intelligence, strongest in coding and cybersecurity
3182
31833151 - `"claude-opus-4-6"`
31843152
31853153 Powerful intelligence for long-running agents and coding
from line 3180
32123180
32133181 High-performance model for agents and coding
32143182
3215 - `string`
3183 - `"claude-mythos-preview"`
32163184
3185 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
3186
3187 New class of intelligence, strongest in coding and cybersecurity
3188
32173189 - `name: "advisor"`
32183190
32193191 Name of the tool.
from line 3224
32523224
32533225 Maximum number of times the tool can be used in the API request.
32543226
3255 exclusiveMinimum: 0
3227 minimum: 1
32563228
32573229 - `strict: optional boolean`
32583230
from line 3315
33433315
33443316 Name of the MCP server to configure tools for
33453317
3346 maxLength: 255, minLength: 1
3318 minLength: 1, maxLength: 255
33473319
33483320 - `cache_control: optional BetaCacheControlEphemeral or null`
33493321
from line 3425
34533425
34543426 The name of the MCP server this listing came from, as `mcp_servers` declares it.
34553427
3456 maxLength: 255, minLength: 1
3428 minLength: 1, maxLength: 255
34573429
34583430 - `tools: array of BetaMCPToolParam`
34593431
from line 3507
35353507
35363508 - `effort: optional "low" or "medium" or "high" or 2 more or null`
35373509
3538 All possible effort levels.
3510 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
35393511
3512 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3513
35403514 - `"low"`
35413515
35423516 - `"medium"`
from line 3533
35593533
35603534- `compaction: optional BetaCompactionConfig or null`
35613535
3562 Compact the whole conversation and return a signed `compaction` block,
3563 alone, that a later request sends back first in `messages`, in place of
3564 the messages it summarizes. There is no trigger and no pause flag: sending
3565 the parameter compacts, and nothing is sampled after the block.
3536 Compaction configuration.
35663537
3567 The summarization prompt is the server's own unless `instructions` are
3568 given, which then replace it for this request; a value that is empty or
3569 only whitespace counts as absent.
3538 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
35703539
35713540 - `type: "summarize"`
35723541
from line 3575
36063575
36073576 Skill ID
36083577
3609 maxLength: 64, minLength: 1
3578 minLength: 1, maxLength: 64
36103579
36113580 - `version: optional string`
36123581
36133582 Skill version or 'latest' for most recent version
36143583
3615 maxLength: 64, minLength: 1
3584 minLength: 1, maxLength: 64
36163585
36173586 - `string`
36183587
from line 3595
36263595
36273596 List of context management edits to apply
36283597
3629 minItems: 0
3630
36313598 - `BetaClearToolUses20250919Edit object`
36323599
36333600 - `type: "clear_tool_uses_20250919"`
from line 3693
37263693
37273694- `diagnostics: optional BetaDiagnosticsParam or null`
37283695
3729 Request-level diagnostics. Currently carries the previous response
3730 id for prompt-cache divergence reporting.
3696 Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request.
37313697
37323698 - `previous_message_id: optional string or null`
37333699
from line 3740
37743740
37753741 The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.
37763742
3777 maxLength: 2048, minLength: 1
3743 minLength: 1, maxLength: 2048
37783744
37793745 - `mode: optional "strict" or "best_effort"`
37803746
from line 3768
38023768
38033769 - `effort: optional "low" or "medium" or "high" or 2 more or null`
38043770
3805 All possible effort levels.
3771 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
38063772
3773 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3774
38073775 - `"low"`
38083776
38093777 - `"medium"`
from line 3794
38263794
38273795 - `task_budget: optional BetaTokenTaskBudget or null`
38283796
3829 User-configurable total token budget across contexts.
3797 Configuration for token budget tracking across contexts.
38303798
38313799 - `type: "tokens"`
38323800
from line 3838
38703838
38713839 - `block_binding: optional BetaThinkingBlockBinding or null`
38723840
3873 Controls for block binding: what happens when a thinking block this
3874 request sends back fails the conversation check. Every field is optional;
3875 an empty object means every default.
3841 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
38763842
38773843 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
38783844
3879 What happens when a thinking block in `messages` fails the conversation
3880 check: it was created in a different conversation, or the messages before
3881 it have changed since. `"error"` (the default) fails the request with a
3882 400 error. `"drop_block"` removes the failing blocks and the request
3883 proceeds; the model no longer sees the dropped reasoning.
3845 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
38843846
38853847 - `"error"`
38863848
from line 3868
39063868
39073869 - `block_binding: optional BetaThinkingBlockBinding or null`
39083870
3909 Controls for block binding: what happens when a thinking block this
3910 request sends back fails the conversation check. Every field is optional;
3911 an empty object means every default.
3871 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
39123872
39133873 - `display: optional "summarized" or "omitted" or "updates" or null`
39143874
from line 3934
39743934
39753935- `speed: optional "standard" or "fast" or null`
39763936
3977 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3937 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
39783938
39793939 - `"standard"`
39803940
from line 4203
42434203
42444204 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
42454205
4246 maximum: 1, minimum: 0
4206 minimum: 0, maximum: 1
42474207
42484208- `top_k: optional number`
42494209
from line 4227
42674227
42684228 Recommended for advanced use cases only.
42694229
4270 maximum: 1, minimum: 0
4230 minimum: 0, maximum: 1
42714231
42724232### Returns
42734233
from line 4249
42894249
42904250 - `container: BetaContainer or null`
42914251
4292 Information about the container used in the request (for the code execution tool)
4252 Information about the container used in this request.
42934253
4254 This will be non-null if a container tool (e.g. code execution) was used.
4255
42944256 - `id: string`
42954257
42964258 Identifier for the container used in this request
from line 4279
43174279
43184280 Skill ID
43194281
4320 maxLength: 64, minLength: 1
4282 minLength: 1, maxLength: 64
43214283
43224284 - `version: string`
43234285
43244286 The resolved version: a skill version ID for custom skills.
43254287
4326 maxLength: 64, minLength: 1
4288 minLength: 1, maxLength: 64
43274289
43284290 - `content: array of BetaContentBlock`
43294291
from line 4458
44964458
44974459 - `text: string`
44984460
4499 minLength: 0
4500
45014461 - `BetaThinkingBlock object`
45024462
45034463 - `type: "thinking"`
from line 4536
45764536
45774537 For a toolset member tool_use, the toolset family.
45784538
4579 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
4539 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
45804540
45814541 - `BetaServerToolUseBlock object`
45824542
from line 5040
50805040
50815041 - `tool_name: string`
50825042
5083 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
5043 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
50845044
50855045 - `tool_use_id: string`
50865046
from line 5090
51305090
51315091 - `text: string`
51325092
5133 minLength: 0
5134
51355093 - `is_error: boolean`
51365094
51375095 default: false
from line 5227
52695227
52705228 This is how the tool will be called by the model and in `tool_use` blocks.
52715229
5272 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
5230 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
52735231
52745232 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
52755233
from line 5491
55335491
55345492 - `configs: optional BetaBrowserToolsetConfigs or null`
55355493
5536 Per-member configuration for `browser_toolset_20260801`: one
5537 optional field per member tool, keyed by the member name — the same
5538 name the member's `tool_use` blocks carry. Every member is an
5539 accepted key, and a member's defaults apply wherever its key is
5540 absent. Unknown keys are rejected: the field set is this toolset
5541 version's complete member set.
5494 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
55425495
55435496 - `type: optional BetaBrowserTypeConfig or null`
55445497
from line 6112
61596112
61606113 - `configs: optional BetaComputerToolsetConfigs or null`
61616114
6162 Per-member configuration for `computer_toolset_20260801`: one
6163 optional field per member tool, keyed by the member name — the same
6164 name the member's `tool_use` blocks carry. Every member is an
6165 accepted key, and a member's defaults apply wherever its key is
6166 absent. Unknown keys are rejected: the field set is this toolset
6167 version's complete member set.
6115 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
61686116
61696117 - `type: optional BetaComputerTypeConfig or null`
61706118
from line 6466
65186466
65196467 Maximum number of times the tool can be used in the API request.
65206468
6521 exclusiveMinimum: 0
6469 minimum: 1
65226470
65236471 - `strict: optional boolean`
65246472
from line 6482
65346482
65356483 The city of the user.
65366484
6537 maxLength: 255, minLength: 1
6485 minLength: 1, maxLength: 255
65386486
65396487 - `country: optional string or null`
65406488
65416489 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
65426490
6543 maxLength: 2, minLength: 2
6491 minLength: 2, maxLength: 2
65446492
65456493 - `region: optional string or null`
65466494
65476495 The region of the user.
65486496
6549 maxLength: 255, minLength: 1
6497 minLength: 1, maxLength: 255
65506498
65516499 - `timezone: optional string or null`
65526500
65536501 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
65546502
6555 maxLength: 255, minLength: 1
6503 minLength: 1, maxLength: 255
65566504
65576505 - `BetaWebFetchTool20250910 object`
65586506
from line 6548
66006548
66016549 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
66026550
6603 exclusiveMinimum: 0
6551 minimum: 1
66046552
66056553 - `max_uses: optional number or null`
66066554
66076555 Maximum number of times the tool can be used in the API request.
66086556
6609 exclusiveMinimum: 0
6557 minimum: 1
66106558
66116559 - `strict: optional boolean`
66126560
from line 6562
66146562
66156563 - `url_sources: optional BetaWebFetchURLSources or null`
66166564
6617 Which sources contribute to the set of URLs web fetch may fetch.
6565 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
66186566
6619 Each key is a tagged variant: `user_input` is `all` or `none`; the
6620 two tool filters are `all`, `none`, `only` (only the named tools'
6621 results) or `except` (every result but the named tools'). A named tool
6622 must be declared in this request's `tools[]`.
6623
66246567 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
66256568
66266569 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 6686
67436686
67446687 Maximum number of times the tool can be used in the API request.
67456688
6746 exclusiveMinimum: 0
6689 minimum: 1
67476690
67486691 - `strict: optional boolean`
67496692
from line 6740
67976740
67986741 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
67996742
6800 exclusiveMinimum: 0
6743 minimum: 1
68016744
68026745 - `max_uses: optional number or null`
68036746
68046747 Maximum number of times the tool can be used in the API request.
68056748
6806 exclusiveMinimum: 0
6749 minimum: 1
68076750
68086751 - `strict: optional boolean`
68096752
from line 6754
68116754
68126755 - `url_sources: optional BetaWebFetchURLSources or null`
68136756
6814 Which sources contribute to the set of URLs web fetch may fetch.
6757 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
68156758
6816 Each key is a tagged variant: `user_input` is `all` or `none`; the
6817 two tool filters are `all`, `none`, `only` (only the named tools'
6818 results) or `except` (every result but the named tools'). A named tool
6819 must be declared in this request's `tools[]`.
6820
68216759 - `BetaWebFetchTool20260309 object`
68226760
68236761 Web fetch tool with use_cache parameter for bypassing cached content.
from line 6802
68646802
68656803 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
68666804
6867 exclusiveMinimum: 0
6805 minimum: 1
68686806
68696807 - `max_uses: optional number or null`
68706808
68716809 Maximum number of times the tool can be used in the API request.
68726810
6873 exclusiveMinimum: 0
6811 minimum: 1
68746812
68756813 - `strict: optional boolean`
68766814
from line 6816
68786816
68796817 - `url_sources: optional BetaWebFetchURLSources or null`
68806818
6881 Which sources contribute to the set of URLs web fetch may fetch.
6819 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
68826820
6883 Each key is a tagged variant: `user_input` is `all` or `none`; the
6884 two tool filters are `all`, `none`, `only` (only the named tools'
6885 results) or `except` (every result but the named tools'). A named tool
6886 must be declared in this request's `tools[]`.
6887
68886821 - `use_cache: optional boolean`
68896822
68906823 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 6862
69296862
69306863 Maximum number of times the tool can be used in the API request.
69316864
6932 exclusiveMinimum: 0
6865 minimum: 1
69336866
69346867 - `response_inclusion: optional "full" or "excluded"`
69356868
from line 6924
69916924
69926925 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
69936926
6994 exclusiveMinimum: 0
6927 minimum: 1
69956928
69966929 - `max_uses: optional number or null`
69976930
69986931 Maximum number of times the tool can be used in the API request.
69996932
7000 exclusiveMinimum: 0
6933 minimum: 1
70016934
70026935 - `response_inclusion: optional "full" or "excluded"`
70036936
from line 6946
70136946
70146947 - `url_sources: optional BetaWebFetchURLSources or null`
70156948
7016 Which sources contribute to the set of URLs web fetch may fetch.
6949 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
70176950
7018 Each key is a tagged variant: `user_input` is `all` or `none`; the
7019 two tool filters are `all`, `none`, `only` (only the named tools'
7020 results) or `except` (every result but the named tools'). A named tool
7021 must be declared in this request's `tools[]`.
7022
70236951 - `use_cache: optional boolean`
70246952
70256953 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 6962
70346962
70356963 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
70366964
6965 - `string`
6966
70376967 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
70386968
70396969 The model that will complete your prompt.
from line 7006
70767006
70777007 Powerful intelligence for long-running agents and coding
70787008
7079 - `"claude-mythos-preview"`
7080
7081 New class of intelligence, strongest in coding and cybersecurity
7082
70837009 - `"claude-opus-4-6"`
70847010
70857011 Powerful intelligence for long-running agents and coding
from line 7038
71127038
71137039 High-performance model for agents and coding
71147040
7115 - `string`
7041 - `"claude-mythos-preview"`
71167042
7043 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
7044
7045 New class of intelligence, strongest in coding and cybersecurity
7046
71177047 - `name: "advisor"`
71187048
71197049 Name of the tool.
from line 7082
71527082
71537083 Maximum number of times the tool can be used in the API request.
71547084
7155 exclusiveMinimum: 0
7085 minimum: 1
71567086
71577087 - `strict: optional boolean`
71587088
from line 7118
71887118
71897119 - `defer_loading: optional boolean`
71907120
7191
7121 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7122
7123 - `strict: optional boolean`
7124
7125 When true, guarantees schema validation on tool names and inputs
7126
7127 - `BetaToolSearchToolRegex20251119 object`
7128
7129 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
7130
7131 - `"tool_search_tool_regex_20251119"`
7132
7133 - `"tool_search_tool_regex"`
7134
7135 - `name: "tool_search_tool_regex"`
7136
7137 Name of the tool.
7138
7139 This is how the tool will be called by the model and in `tool_use` blocks.
7140
7141 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7142
7143 - `"direct"`
7144
7145 - `"code_execution_20250825"`
7146
7147 - `"code_execution_20260120"`
7148
7149 - `"code_execution_20260521"`
7150
7151 - `cache_control: optional BetaCacheControlEphemeral or null`
7152
7153 Create a cache control breakpoint at this content block.
7154
7155 - `defer_loading: optional boolean`
7156
7157 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7158
7159 - `strict: optional boolean`
7160
7161 When true, guarantees schema validation on tool names and inputs
7162
7163 - `BetaMCPToolset object`
7164
7165 Configuration for a group of tools from an MCP server.
7166
7167 Allows configuring enabled status and defer_loading for all tools
7168 from an MCP server, with optional per-tool overrides.
7169
7170 - `type: "mcp_toolset"`
7171
7172 - `mcp_server_name: string`
7173
7174 Name of the MCP server to configure tools for
7175
7176 minLength: 1, maxLength: 255
7177
7178 - `cache_control: optional BetaCacheControlEphemeral or null`
7179
7180 Create a cache control breakpoint at this content block.
7181
7182 - `configs: optional map[BetaMCPToolConfig] or null`
7183
7184 Configuration overrides for specific tools, keyed by tool name
7185
7186 - `defer_loading: optional boolean`
7187
7188 - `enabled: optional boolean`
7189
7190 - `default_config: optional BetaMCPToolDefaultConfig`
7191
7192 Default configuration applied to all tools from this server
7193
7194 - `defer_loading: optional boolean`
7195
7196 - `enabled: optional boolean`
7197
7198 - `tools: optional array of BetaMCPToolParam or null`
7199
7200 The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.
7201
7202 - `input_schema: map[unknown]`
7203
7204 The tool's input schema as the MCP server lists it, verbatim.
7205
7206 - `name: s
api/beta/messages/batches Changed · +422 / -554 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.
from line 137
137137
138138 List of requests for prompt completion. Each is an individual request to create a Message.
139139
140 maxItems: 100000, minItems: 1
140 minItems: 1, maxItems: 100000
141141
142142 - `custom_id: string`
143143
from line 145
145145
146146 Must be unique for each request within the Message Batch.
147147
148 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,64}$
148 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$
149149
150150 - `params: object`
151151
from line 265
265265
266266 - `document_title: string or null`
267267
268 maxLength: 500, minLength: 1
268 minLength: 1, maxLength: 500
269269
270270 - `end_char_index: number`
271271
from line 285
285285
286286 - `document_title: string or null`
287287
288 maxLength: 500, minLength: 1
288 minLength: 1, maxLength: 500
289289
290290 - `end_page_number: number`
291291
from line 309
309309
310310 - `document_title: string or null`
311311
312 maxLength: 500, minLength: 1
312 minLength: 1, maxLength: 500
313313
314314 - `end_block_index: number`
315315
from line 333
333333
334334 - `title: string or null`
335335
336 maxLength: 512, minLength: 1
336 minLength: 1, maxLength: 512
337337
338338 - `url: string`
339339
from line 489
489489
490490 - `title: optional string or null`
491491
492 maxLength: 500, minLength: 1
492 minLength: 1, maxLength: 500
493493
494494 - `BetaSearchResultBlockParam object`
495495
from line 553
553553
554554 - `name: string`
555555
556 maxLength: 200, minLength: 1
556 minLength: 1, maxLength: 200
557557
558558 - `cache_control: optional BetaCacheControlEphemeral or null`
559559
from line 589
589589
590590 For a toolset member tool_use, the toolset family this member belongs to.
591591
592 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
592 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
593593
594594 - `BetaToolResultBlockParam object`
595595
from line 625
625625
626626 - `tool_name: string`
627627
628 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
628 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
629629
630630 - `cache_control: optional BetaCacheControlEphemeral or null`
631631
from line 653
653653
654654 The caller-assigned identifier for this tab, unique within the inventory.
655655
656 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
656 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
657657
658658 - `title: string`
659659
from line 679
679679
680680 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
681681
682 maxItems: 200, minItems: 1
682 minItems: 1, maxItems: 200
683683
684684 - `BetaBrowserStateChangeTabOpened object`
685685
from line 697
697697
698698 The `tab_id` of the opened tab, present in `tabs`.
699699
700 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
700 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
701701
702702 - `BetaBrowserStateChangeDownloadStarted object`
703703
from line 709
709709
710710 The caller-assigned identifier for this download, stable across the state changes reporting it.
711711
712 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
712 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
713713
714714 - `url: string`
715715
from line 730
730730
731731 The caller-assigned identifier for this download, stable across the state changes reporting it.
732732
733 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
733 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
734734
735735 - `url: string`
736736
from line 742
742742
743743 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
744744
745 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
745 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
746746
747747 - `size_bytes: optional number or null`
748748
from line 760
760760
761761 The caller-assigned identifier for this download, stable across the state changes reporting it.
762762
763 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
763 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
764764
765765 - `url: string`
766766
from line 772
772772
773773 The failure or cancellation detail, when known.
774774
775 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
775 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
776776
777777 - `is_error: optional boolean`
778778
from line 780
780780
781781 For a toolset member tool_result, the toolset family of the paired tool_use.
782782
783 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
783 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
784784
785785 - `BetaServerToolUseBlockParam object`
786786
from line 1212
12121212
12131213 - `tool_name: string`
12141214
1215 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1215 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
12161216
12171217 - `cache_control: optional BetaCacheControlEphemeral or null`
12181218
from line 1404
14041404
14051405 This is how the tool will be called by the model and in `tool_use` blocks.
14061406
1407 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1407 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
14081408
14091409 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
14101410
from line 1655
16551655
16561656 - `configs: optional BetaBrowserToolsetConfigs or null`
16571657
1658 Per-member configuration for `browser_toolset_20260801`: one
1659 optional field per member tool, keyed by the member name — the same
1660 name the member's `tool_use` blocks carry. Every member is an
1661 accepted key, and a member's defaults apply wherever its key is
1662 absent. Unknown keys are rejected: the field set is this toolset
1663 version's complete member set.
1658 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
16641659
16651660 - `type: optional BetaBrowserTypeConfig or null`
16661661
from line 2276
22812276
22822277 - `configs: optional BetaComputerToolsetConfigs or null`
22832278
2284 Per-member configuration for `computer_toolset_20260801`: one
2285 optional field per member tool, keyed by the member name — the same
2286 name the member's `tool_use` blocks carry. Every member is an
2287 accepted key, and a member's defaults apply wherever its key is
2288 absent. Unknown keys are rejected: the field set is this toolset
2289 version's complete member set.
2279 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
22902280
22912281 - `type: optional BetaComputerTypeConfig or null`
22922282
from line 2630
26402630
26412631 Maximum number of times the tool can be used in the API request.
26422632
2643 exclusiveMinimum: 0
2633 minimum: 1
26442634
26452635 - `strict: optional boolean`
26462636
from line 2646
26562646
26572647 The city of the user.
26582648
2659 maxLength: 255, minLength: 1
2649 minLength: 1, maxLength: 255
26602650
26612651 - `country: optional string or null`
26622652
26632653 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
26642654
2665 maxLength: 2, minLength: 2
2655 minLength: 2, maxLength: 2
26662656
26672657 - `region: optional string or null`
26682658
26692659 The region of the user.
26702660
2671 maxLength: 255, minLength: 1
2661 minLength: 1, maxLength: 255
26722662
26732663 - `timezone: optional string or null`
26742664
26752665 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
26762666
2677 maxLength: 255, minLength: 1
2667 minLength: 1, maxLength: 255
26782668
26792669 - `BetaWebFetchTool20250910 object`
26802670
from line 2710
27202710
27212711 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
27222712
2723 exclusiveMinimum: 0
2713 minimum: 1
27242714
27252715 - `max_uses: optional number or null`
27262716
27272717 Maximum number of times the tool can be used in the API request.
27282718
2729 exclusiveMinimum: 0
2719 minimum: 1
27302720
27312721 - `strict: optional boolean`
27322722
from line 2724
27342724
27352725 - `url_sources: optional BetaWebFetchURLSources or null`
27362726
2737 Which sources contribute to the set of URLs web fetch may fetch.
2727 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27382728
2739 Each key is a tagged variant: `user_input` is `all` or `none`; the
2740 two tool filters are `all`, `none`, `only` (only the named tools'
2741 results) or `except` (every result but the named tools'). A named tool
2742 must be declared in this request's `tools[]`.
2743
27442729 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
27452730
27462731 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2848
28632848
28642849 Maximum number of times the tool can be used in the API request.
28652850
2866 exclusiveMinimum: 0
2851 minimum: 1
28672852
28682853 - `strict: optional boolean`
28692854
from line 2902
29172902
29182903 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29192904
2920 exclusiveMinimum: 0
2905 minimum: 1
29212906
29222907 - `max_uses: optional number or null`
29232908
29242909 Maximum number of times the tool can be used in the API request.
29252910
2926 exclusiveMinimum: 0
2911 minimum: 1
29272912
29282913 - `strict: optional boolean`
29292914
from line 2916
29312916
29322917 - `url_sources: optional BetaWebFetchURLSources or null`
29332918
2934 Which sources contribute to the set of URLs web fetch may fetch.
2919 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29352920
2936 Each key is a tagged variant: `user_input` is `all` or `none`; the
2937 two tool filters are `all`, `none`, `only` (only the named tools'
2938 results) or `except` (every result but the named tools'). A named tool
2939 must be declared in this request's `tools[]`.
2940
29412921 - `BetaWebFetchTool20260309 object`
29422922
29432923 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2964
29842964
29852965 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29862966
2987 exclusiveMinimum: 0
2967 minimum: 1
29882968
29892969 - `max_uses: optional number or null`
29902970
29912971 Maximum number of times the tool can be used in the API request.
29922972
2993 exclusiveMinimum: 0
2973 minimum: 1
29942974
29952975 - `strict: optional boolean`
29962976
from line 2978
29982978
29992979 - `url_sources: optional BetaWebFetchURLSources or null`
30002980
3001 Which sources contribute to the set of URLs web fetch may fetch.
2981 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
30022982
3003 Each key is a tagged variant: `user_input` is `all` or `none`; the
3004 two tool filters are `all`, `none`, `only` (only the named tools'
3005 results) or `except` (every result but the named tools'). A named tool
3006 must be declared in this request's `tools[]`.
3007
30082983 - `use_cache: optional boolean`
30092984
30102985 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3024
30493024
30503025 Maximum number of times the tool can be used in the API request.
30513026
3052 exclusiveMinimum: 0
3027 minimum: 1
30533028
30543029 - `response_inclusion: optional "full" or "excluded"`
30553030
from line 3086
31113086
31123087 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
31133088
3114 exclusiveMinimum: 0
3089 minimum: 1
31153090
31163091 - `max_uses: optional number or null`
31173092
31183093 Maximum number of times the tool can be used in the API request.
31193094
3120 exclusiveMinimum: 0
3095 minimum: 1
31213096
31223097 - `response_inclusion: optional "full" or "excluded"`
31233098
from line 3108
31333108
31343109 - `url_sources: optional BetaWebFetchURLSources or null`
31353110
3136 Which sources contribute to the set of URLs web fetch may fetch.
3111 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
31373112
3138 Each key is a tagged variant: `user_input` is `all` or `none`; the
3139 two tool filters are `all`, `none`, `only` (only the named tools'
3140 results) or `except` (every result but the named tools'). A named tool
3141 must be declared in this request's `tools[]`.
3142
31433113 - `use_cache: optional boolean`
31443114
31453115 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3124
31543124
31553125 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31563126
3127 - `string`
3128
31573129 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
31583130
31593131 The model that will complete your prompt.
from line 3168
31963168
31973169 Powerful intelligence for long-running agents and coding
31983170
3199 - `"claude-mythos-preview"`
3200
3201 New class of intelligence, strongest in coding and cybersecurity
3202
32033171 - `"claude-opus-4-6"`
32043172
32053173 Powerful intelligence for long-running agents and coding
from line 3200
32323200
32333201 High-performance model for agents and coding
32343202
3235 - `string`
3203 - `"claude-mythos-preview"`
32363204
3205 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
3206
3207 New class of intelligence, strongest in coding and cybersecurity
3208
32373209 - `name: "advisor"`
32383210
32393211 Name of the tool.
from line 3244
32723244
32733245 Maximum number of times the tool can be used in the API request.
32743246
3275 exclusiveMinimum: 0
3247 minimum: 1
32763248
32773249 - `strict: optional boolean`
32783250
from line 3335
33633335
33643336 Name of the MCP server to configure tools for
33653337
3366 maxLength: 255, minLength: 1
3338 minLength: 1, maxLength: 255
33673339
33683340 - `cache_control: optional BetaCacheControlEphemeral or null`
33693341
from line 3445
34733445
34743446 The name of the MCP server this listing came from, as `mcp_servers` declares it.
34753447
3476 maxLength: 255, minLength: 1
3448 minLength: 1, maxLength: 255
34773449
34783450 - `tools: array of BetaMCPToolParam`
34793451
from line 3527
35553527
35563528 - `effort: optional "low" or "medium" or "high" or 2 more or null`
35573529
3558 All possible effort levels.
3530 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
35593531
3532 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3533
35603534 - `"low"`
35613535
35623536 - `"medium"`
from line 3553
35793553
35803554 - `compaction: optional BetaCompactionConfig or null`
35813555
3582 Compact the whole conversation and return a signed `compaction` block,
3583 alone, that a later request sends back first in `messages`, in place of
3584 the messages it summarizes. There is no trigger and no pause flag: sending
3585 the parameter compacts, and nothing is sampled after the block.
3556 Compaction configuration.
35863557
3587 The summarization prompt is the server's own unless `instructions` are
3588 given, which then replace it for this request; a value that is empty or
3589 only whitespace counts as absent.
3558 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
35903559
35913560 - `type: "summarize"`
35923561
from line 3595
36263595
36273596 Skill ID
36283597
3629 maxLength: 64, minLength: 1
3598 minLength: 1, maxLength: 64
36303599
36313600 - `version: optional string`
36323601
36333602 Skill version or 'latest' for most recent version
36343603
3635 maxLength: 64, minLength: 1
3604 minLength: 1, maxLength: 64
36363605
36373606 - `string`
36383607
from line 3615
36463615
36473616 List of context management edits to apply
36483617
3649 minItems: 0
3650
36513618 - `BetaClearToolUses20250919Edit object`
36523619
36533620 - `type: "clear_tool_uses_20250919"`
from line 3713
37463713
37473714 - `diagnostics: optional BetaDiagnosticsParam or null`
37483715
3749 Request-level diagnostics. Currently carries the previous response
3750 id for prompt-cache divergence reporting.
3716 Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request.
37513717
37523718 - `previous_message_id: optional string or null`
37533719
from line 3760
37943760
37953761 The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.
37963762
3797 maxLength: 2048, minLength: 1
3763 minLength: 1, maxLength: 2048
37983764
37993765 - `mode: optional "strict" or "best_effort"`
38003766
from line 3788
38223788
38233789 - `effort: optional "low" or "medium" or "high" or 2 more or null`
38243790
3825 All possible effort levels.
3791 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
38263792
3793 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3794
38273795 - `"low"`
38283796
38293797 - `"medium"`
from line 3814
38463814
38473815 - `task_budget: optional BetaTokenTaskBudget or null`
38483816
3849 User-configurable total token budget across contexts.
3817 Configuration for token budget tracking across contexts.
38503818
38513819 - `type: "tokens"`
38523820
from line 3858
38903858
38913859 - `block_binding: optional BetaThinkingBlockBinding or null`
38923860
3893 Controls for block binding: what happens when a thinking block this
3894 request sends back fails the conversation check. Every field is optional;
3895 an empty object means every default.
3861 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
38963862
38973863 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
38983864
3899 What happens when a thinking block in `messages` fails the conversation
3900 check: it was created in a different conversation, or the messages before
3901 it have changed since. `"error"` (the default) fails the request with a
3902 400 error. `"drop_block"` removes the failing blocks and the request
3903 proceeds; the model no longer sees the dropped reasoning.
3865 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
39043866
39053867 - `"error"`
39063868
from line 3888
39263888
39273889 - `block_binding: optional BetaThinkingBlockBinding or null`
39283890
3929 Controls for block binding: what happens when a thinking block this
3930 request sends back fails the conversation check. Every field is optional;
3931 an empty object means every default.
3891 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
39323892
39333893 - `display: optional "summarized" or "omitted" or "updates" or null`
39343894
from line 3954
39943954
39953955 - `speed: optional "standard" or "fast" or null`
39963956
3997 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3957 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
39983958
39993959 - `"standard"`
40003960
from line 4223
42634223
42644224 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
42654225
4266 maximum: 1, minimum: 0
4226 minimum: 0, maximum: 1
42674227
42684228 - `top_k: optional number`
42694229
from line 4247
42874247
42884248 Recommended for advanced use cases only.
42894249
4290 maximum: 1, minimum: 0
4250 minimum: 0, maximum: 1
42914251
42924252### Returns
42934253
from line 4701
47414701
47424702 Defaults to `20`. Ranges from `1` to `1000`.
47434703
4744 default: 20, maximum: 1000, minimum: 1
4704 default: 20, minimum: 1, maximum: 1000
47454705
47464706### Headers
47474707
from line 5580
56205580
56215581 - `container: BetaContainer or null`
56225582
5623 Information about the container used in the request (for the code execution tool)
5583 Information about the container used in this request.
56245584
5585 This will be non-null if a container tool (e.g. code execution) was used.
5586
56255587 - `id: string`
56265588
56275589 Identifier for the container used in this request
from line 5610
56485610
56495611 Skill ID
56505612
5651 maxLength: 64, minLength: 1
5613 minLength: 1, maxLength: 64
56525614
56535615 - `version: string`
56545616
56555617 The resolved version: a skill version ID for custom skills.
56565618
5657 maxLength: 64, minLength: 1
5619 minLength: 1, maxLength: 64
56585620
56595621 - `content: array of BetaContentBlock`
56605622
from line 5789
58275789
58285790 - `text: string`
58295791
5830 minLength: 0
5831
58325792 - `BetaThinkingBlock object`
58335793
58345794 - `type: "thinking"`
from line 5867
59075867
59085868 For a toolset member tool_use, the toolset family.
59095869
5910 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
5870 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
59115871
59125872 - `BetaServerToolUseBlock object`
59135873
from line 6371
64116371
64126372 - `tool_name: string`
64136373
6414 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
6374 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
64156375
64166376 - `tool_use_id: string`
64176377
from line 6421
64616421
64626422 - `text: string`
64636423
6464 minLength: 0
6465
64666424 - `is_error: boolean`
64676425
64686426 default: false
from line 6558
66006558
66016559 This is how the tool will be called by the model and in `tool_use` blocks.
66026560
6603 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
6561 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
66046562
66056563 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
66066564
from line 6822
68646822
68656823 - `configs: optional BetaBrowserToolsetConfigs or null`
68666824
6867 Per-member configuration for `browser_toolset_20260801`: one
6868 optional field per member tool, keyed by the member name — the same
6869 name the member's `tool_use` blocks carry. Every member is an
6870 accepted key, and a member's defaults apply wherever its key is
6871 absent. Unknown keys are rejected: the field set is this toolset
6872 version's complete member set.
6825 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
68736826
68746827 - `type: optional BetaBrowserTypeConfig or null`
68756828
from line 7284
73317284
73327285 - `BetaToolComputerUse20250124 object`
73337286
7334
7287 - `type: "computer_20250124"`
7288
7289 - `display_height_px: number`
7290
7291 The height of the display in pixels.
7292
7293 minimum: 1
7294
7295 - `display_width_px: number`
7296
7297 The width of the display in pixels.
7298
7299 minimum: 1
7300
7301 - `name: "computer"`
7302
7303 Name of the tool.
7304
7305 This is how the tool will be called by the model and in `tool_use` blocks.
7306
7307 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7308
7309 - `"direct"`
7310
7311 - `"code_execution_20250825"`
7312
7313 - `"code_execution_20260120"`
7314
7315 - `"code_execution_20260521"`
7316
7317 - `cache_control: optional BetaCacheControlEphemeral or null`
7318
7319 Create a cache control breakpoint at this content block.
7320
7321 - `defer_loading: optional boolean`
7322
7323 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7324
7325 - `display_number: optional number or null`
7326
7327 The X11 display number (e.g. 0, 1) for the display.
7328
7329 minimum: 0
7330
7331 - `input_examples: optional array of map[unknown]`
7332
7333 - `strict: optional boolean`
7334
7335 When true, guarantees schema validation on tool names and inputs
7336
7337 - `BetaToolTextEditor20241022 object`
7338
7339 - `type: "text_editor_20241022"`
7340
7341 - `name: "str_replace_editor"`
7342
7343 Name of the tool.
7344
7345 This is how the tool will be called by the model and
api/beta/messages/batches/create Changed · +101 / -141 lines
from line 135
135135
136136 List of requests for prompt completion. Each is an individual request to create a Message.
137137
138 maxItems: 100000, minItems: 1
138 minItems: 1, maxItems: 100000
139139
140140 - `custom_id: string`
141141
from line 143
143143
144144 Must be unique for each request within the Message Batch.
145145
146 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,64}$
146 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$
147147
148148 - `params: object`
149149
from line 263
263263
264264 - `document_title: string or null`
265265
266 maxLength: 500, minLength: 1
266 minLength: 1, maxLength: 500
267267
268268 - `end_char_index: number`
269269
from line 283
283283
284284 - `document_title: string or null`
285285
286 maxLength: 500, minLength: 1
286 minLength: 1, maxLength: 500
287287
288288 - `end_page_number: number`
289289
from line 307
307307
308308 - `document_title: string or null`
309309
310 maxLength: 500, minLength: 1
310 minLength: 1, maxLength: 500
311311
312312 - `end_block_index: number`
313313
from line 331
331331
332332 - `title: string or null`
333333
334 maxLength: 512, minLength: 1
334 minLength: 1, maxLength: 512
335335
336336 - `url: string`
337337
from line 487
487487
488488 - `title: optional string or null`
489489
490 maxLength: 500, minLength: 1
490 minLength: 1, maxLength: 500
491491
492492 - `BetaSearchResultBlockParam object`
493493
from line 551
551551
552552 - `name: string`
553553
554 maxLength: 200, minLength: 1
554 minLength: 1, maxLength: 200
555555
556556 - `cache_control: optional BetaCacheControlEphemeral or null`
557557
from line 587
587587
588588 For a toolset member tool_use, the toolset family this member belongs to.
589589
590 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
590 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
591591
592592 - `BetaToolResultBlockParam object`
593593
from line 623
623623
624624 - `tool_name: string`
625625
626 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
626 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
627627
628628 - `cache_control: optional BetaCacheControlEphemeral or null`
629629
from line 651
651651
652652 The caller-assigned identifier for this tab, unique within the inventory.
653653
654 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
654 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
655655
656656 - `title: string`
657657
from line 677
677677
678678 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
679679
680 maxItems: 200, minItems: 1
680 minItems: 1, maxItems: 200
681681
682682 - `BetaBrowserStateChangeTabOpened object`
683683
from line 695
695695
696696 The `tab_id` of the opened tab, present in `tabs`.
697697
698 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
698 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
699699
700700 - `BetaBrowserStateChangeDownloadStarted object`
701701
from line 707
707707
708708 The caller-assigned identifier for this download, stable across the state changes reporting it.
709709
710 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
710 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
711711
712712 - `url: string`
713713
from line 728
728728
729729 The caller-assigned identifier for this download, stable across the state changes reporting it.
730730
731 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
731 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
732732
733733 - `url: string`
734734
from line 740
740740
741741 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
742742
743 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
743 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
744744
745745 - `size_bytes: optional number or null`
746746
from line 758
758758
759759 The caller-assigned identifier for this download, stable across the state changes reporting it.
760760
761 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
761 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
762762
763763 - `url: string`
764764
from line 770
770770
771771 The failure or cancellation detail, when known.
772772
773 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
773 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
774774
775775 - `is_error: optional boolean`
776776
from line 778
778778
779779 For a toolset member tool_result, the toolset family of the paired tool_use.
780780
781 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
781 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
782782
783783 - `BetaServerToolUseBlockParam object`
784784
from line 1210
12101210
12111211 - `tool_name: string`
12121212
1213 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1213 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
12141214
12151215 - `cache_control: optional BetaCacheControlEphemeral or null`
12161216
from line 1402
14021402
14031403 This is how the tool will be called by the model and in `tool_use` blocks.
14041404
1405 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1405 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
14061406
14071407 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
14081408
from line 1653
16531653
16541654 - `configs: optional BetaBrowserToolsetConfigs or null`
16551655
1656 Per-member configuration for `browser_toolset_20260801`: one
1657 optional field per member tool, keyed by the member name — the same
1658 name the member's `tool_use` blocks carry. Every member is an
1659 accepted key, and a member's defaults apply wherever its key is
1660 absent. Unknown keys are rejected: the field set is this toolset
1661 version's complete member set.
1656 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
16621657
16631658 - `type: optional BetaBrowserTypeConfig or null`
16641659
from line 2274
22792274
22802275 - `configs: optional BetaComputerToolsetConfigs or null`
22812276
2282 Per-member configuration for `computer_toolset_20260801`: one
2283 optional field per member tool, keyed by the member name — the same
2284 name the member's `tool_use` blocks carry. Every member is an
2285 accepted key, and a member's defaults apply wherever its key is
2286 absent. Unknown keys are rejected: the field set is this toolset
2287 version's complete member set.
2277 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
22882278
22892279 - `type: optional BetaComputerTypeConfig or null`
22902280
from line 2628
26382628
26392629 Maximum number of times the tool can be used in the API request.
26402630
2641 exclusiveMinimum: 0
2631 minimum: 1
26422632
26432633 - `strict: optional boolean`
26442634
from line 2644
26542644
26552645 The city of the user.
26562646
2657 maxLength: 255, minLength: 1
2647 minLength: 1, maxLength: 255
26582648
26592649 - `country: optional string or null`
26602650
26612651 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
26622652
2663 maxLength: 2, minLength: 2
2653 minLength: 2, maxLength: 2
26642654
26652655 - `region: optional string or null`
26662656
26672657 The region of the user.
26682658
2669 maxLength: 255, minLength: 1
2659 minLength: 1, maxLength: 255
26702660
26712661 - `timezone: optional string or null`
26722662
26732663 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
26742664
2675 maxLength: 255, minLength: 1
2665 minLength: 1, maxLength: 255
26762666
26772667 - `BetaWebFetchTool20250910 object`
26782668
from line 2708
27182708
27192709 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
27202710
2721 exclusiveMinimum: 0
2711 minimum: 1
27222712
27232713 - `max_uses: optional number or null`
27242714
27252715 Maximum number of times the tool can be used in the API request.
27262716
2727 exclusiveMinimum: 0
2717 minimum: 1
27282718
27292719 - `strict: optional boolean`
27302720
from line 2722
27322722
27332723 - `url_sources: optional BetaWebFetchURLSources or null`
27342724
2735 Which sources contribute to the set of URLs web fetch may fetch.
2725 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27362726
2737 Each key is a tagged variant: `user_input` is `all` or `none`; the
2738 two tool filters are `all`, `none`, `only` (only the named tools'
2739 results) or `except` (every result but the named tools'). A named tool
2740 must be declared in this request's `tools[]`.
2741
27422727 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
27432728
27442729 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2846
28612846
28622847 Maximum number of times the tool can be used in the API request.
28632848
2864 exclusiveMinimum: 0
2849 minimum: 1
28652850
28662851 - `strict: optional boolean`
28672852
from line 2900
29152900
29162901 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29172902
2918 exclusiveMinimum: 0
2903 minimum: 1
29192904
29202905 - `max_uses: optional number or null`
29212906
29222907 Maximum number of times the tool can be used in the API request.
29232908
2924 exclusiveMinimum: 0
2909 minimum: 1
29252910
29262911 - `strict: optional boolean`
29272912
from line 2914
29292914
29302915 - `url_sources: optional BetaWebFetchURLSources or null`
29312916
2932 Which sources contribute to the set of URLs web fetch may fetch.
2917 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29332918
2934 Each key is a tagged variant: `user_input` is `all` or `none`; the
2935 two tool filters are `all`, `none`, `only` (only the named tools'
2936 results) or `except` (every result but the named tools'). A named tool
2937 must be declared in this request's `tools[]`.
2938
29392919 - `BetaWebFetchTool20260309 object`
29402920
29412921 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2962
29822962
29832963 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29842964
2985 exclusiveMinimum: 0
2965 minimum: 1
29862966
29872967 - `max_uses: optional number or null`
29882968
29892969 Maximum number of times the tool can be used in the API request.
29902970
2991 exclusiveMinimum: 0
2971 minimum: 1
29922972
29932973 - `strict: optional boolean`
29942974
from line 2976
29962976
29972977 - `url_sources: optional BetaWebFetchURLSources or null`
29982978
2999 Which sources contribute to the set of URLs web fetch may fetch.
2979 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
30002980
3001 Each key is a tagged variant: `user_input` is `all` or `none`; the
3002 two tool filters are `all`, `none`, `only` (only the named tools'
3003 results) or `except` (every result but the named tools'). A named tool
3004 must be declared in this request's `tools[]`.
3005
30062981 - `use_cache: optional boolean`
30072982
30082983 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3022
30473022
30483023 Maximum number of times the tool can be used in the API request.
30493024
3050 exclusiveMinimum: 0
3025 minimum: 1
30513026
30523027 - `response_inclusion: optional "full" or "excluded"`
30533028
from line 3084
31093084
31103085 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
31113086
3112 exclusiveMinimum: 0
3087 minimum: 1
31133088
31143089 - `max_uses: optional number or null`
31153090
31163091 Maximum number of times the tool can be used in the API request.
31173092
3118 exclusiveMinimum: 0
3093 minimum: 1
31193094
31203095 - `response_inclusion: optional "full" or "excluded"`
31213096
from line 3106
31313106
31323107 - `url_sources: optional BetaWebFetchURLSources or null`
31333108
3134 Which sources contribute to the set of URLs web fetch may fetch.
3109 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
31353110
3136 Each key is a tagged variant: `user_input` is `all` or `none`; the
3137 two tool filters are `all`, `none`, `only` (only the named tools'
3138 results) or `except` (every result but the named tools'). A named tool
3139 must be declared in this request's `tools[]`.
3140
31413111 - `use_cache: optional boolean`
31423112
31433113 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3122
31523122
31533123 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31543124
3125 - `string`
3126
31553127 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
31563128
31573129 The model that will complete your prompt.
from line 3166
31943166
31953167 Powerful intelligence for long-running agents and coding
31963168
3197 - `"claude-mythos-preview"`
3198
3199 New class of intelligence, strongest in coding and cybersecurity
3200
32013169 - `"claude-opus-4-6"`
32023170
32033171 Powerful intelligence for long-running agents and coding
from line 3198
32303198
32313199 High-performance model for agents and coding
32323200
3233 - `string`
3201 - `"claude-mythos-preview"`
32343202
3203 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
3204
3205 New class of intelligence, strongest in coding and cybersecurity
3206
32353207 - `name: "advisor"`
32363208
32373209 Name of the tool.
from line 3242
32703242
32713243 Maximum number of times the tool can be used in the API request.
32723244
3273 exclusiveMinimum: 0
3245 minimum: 1
32743246
32753247 - `strict: optional boolean`
32763248
from line 3333
33613333
33623334 Name of the MCP server to configure tools for
33633335
3364 maxLength: 255, minLength: 1
3336 minLength: 1, maxLength: 255
33653337
33663338 - `cache_control: optional BetaCacheControlEphemeral or null`
33673339
from line 3443
34713443
34723444 The name of the MCP server this listing came from, as `mcp_servers` declares it.
34733445
3474 maxLength: 255, minLength: 1
3446 minLength: 1, maxLength: 255
34753447
34763448 - `tools: array of BetaMCPToolParam`
34773449
from line 3525
35533525
35543526 - `effort: optional "low" or "medium" or "high" or 2 more or null`
35553527
3556 All possible effort levels.
3528 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
35573529
3530 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3531
35583532 - `"low"`
35593533
35603534 - `"medium"`
from line 3551
35773551
35783552 - `compaction: optional BetaCompactionConfig or null`
35793553
3580 Compact the whole conversation and return a signed `compaction` block,
3581 alone, that a later request sends back first in `messages`, in place of
3582 the messages it summarizes. There is no trigger and no pause flag: sending
3583 the parameter compacts, and nothing is sampled after the block.
3554 Compaction configuration.
35843555
3585 The summarization prompt is the server's own unless `instructions` are
3586 given, which then replace it for this request; a value that is empty or
3587 only whitespace counts as absent.
3556 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
35883557
35893558 - `type: "summarize"`
35903559
from line 3593
36243593
36253594 Skill ID
36263595
3627 maxLength: 64, minLength: 1
3596 minLength: 1, maxLength: 64
36283597
36293598 - `version: optional string`
36303599
36313600 Skill version or 'latest' for most recent version
36323601
3633 maxLength: 64, minLength: 1
3602 minLength: 1, maxLength: 64
36343603
36353604 - `string`
36363605
from line 3613
36443613
36453614 List of context management edits to apply
36463615
3647 minItems: 0
3648
36493616 - `BetaClearToolUses20250919Edit object`
36503617
36513618 - `type: "clear_tool_uses_20250919"`
from line 3711
37443711
37453712 - `diagnostics: optional BetaDiagnosticsParam or null`
37463713
3747 Request-level diagnostics. Currently carries the previous response
3748 id for prompt-cache divergence reporting.
3714 Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request.
37493715
37503716 - `previous_message_id: optional string or null`
37513717
from line 3758
37923758
37933759 The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.
37943760
3795 maxLength: 2048, minLength: 1
3761 minLength: 1, maxLength: 2048
37963762
37973763 - `mode: optional "strict" or "best_effort"`
37983764
from line 3786
38203786
38213787 - `effort: optional "low" or "medium" or "high" or 2 more or null`
38223788
3823 All possible effort levels.
3789 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
38243790
3791 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3792
38253793 - `"low"`
38263794
38273795 - `"medium"`
from line 3812
38443812
38453813 - `task_budget: optional BetaTokenTaskBudget or null`
38463814
3847 User-configurable total token budget across contexts.
3815 Configuration for token budget tracking across contexts.
38483816
38493817 - `type: "tokens"`
38503818
from line 3856
38883856
38893857 - `block_binding: optional BetaThinkingBlockBinding or null`
38903858
3891 Controls for block binding: what happens when a thinking block this
3892 request sends back fails the conversation check. Every field is optional;
3893 an empty object means every default.
3859 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
38943860
38953861 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
38963862
3897 What happens when a thinking block in `messages` fails the conversation
3898 check: it was created in a different conversation, or the messages before
3899 it have changed since. `"error"` (the default) fails the request with a
3900 400 error. `"drop_block"` removes the failing blocks and the request
3901 proceeds; the model no longer sees the dropped reasoning.
3863 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
39023864
39033865 - `"error"`
39043866
from line 3886
39243886
39253887 - `block_binding: optional BetaThinkingBlockBinding or null`
39263888
3927 Controls for block binding: what happens when a thinking block this
3928 request sends back fails the conversation check. Every field is optional;
3929 an empty object means every default.
3889 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
39303890
39313891 - `display: optional "summarized" or "omitted" or "updates" or null`
39323892
from line 3952
39923952
39933953 - `speed: optional "standard" or "fast" or null`
39943954
3995 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3955 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
39963956
39973957 - `"standard"`
39983958
from line 4221
42614221
42624222 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
42634223
4264 maximum: 1, minimum: 0
4224 minimum: 0, maximum: 1
42654225
42664226 - `top_k: optional number`
42674227
from line 4245
42854245
42864246 Recommended for advanced use cases only.
42874247
4288 maximum: 1, minimum: 0
4248 minimum: 0, maximum: 1
42894249
42904250## Returns
42914251
api/beta/messages/batches/results Changed · +80 / -103 lines
from line 173
173173
174174 - `container: BetaContainer or null`
175175
176 Information about the container used in the request (for the code execution tool)
176 Information about the container used in this request.
177177
178 This will be non-null if a container tool (e.g. code execution) was used.
179
178180 - `id: string`
179181
180182 Identifier for the container used in this request
from line 203
201203
202204 Skill ID
203205
204 maxLength: 64, minLength: 1
206 minLength: 1, maxLength: 64
205207
206208 - `version: string`
207209
208210 The resolved version: a skill version ID for custom skills.
209211
210 maxLength: 64, minLength: 1
212 minLength: 1, maxLength: 64
211213
212214 - `content: array of BetaContentBlock`
213215
from line 382
380382
381383 - `text: string`
382384
383 minLength: 0
384
385385 - `BetaThinkingBlock object`
386386
387387 - `type: "thinking"`
from line 460
460460
461461 For a toolset member tool_use, the toolset family.
462462
463 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
463 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
464464
465465 - `BetaServerToolUseBlock object`
466466
from line 964
964964
965965 - `tool_name: string`
966966
967 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
967 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
968968
969969 - `tool_use_id: string`
970970
from line 1014
10141014
10151015 - `text: string`
10161016
1017 minLength: 0
1018
10191017 - `is_error: boolean`
10201018
10211019 default: false
from line 1151
11531151
11541152 This is how the tool will be called by the model and in `tool_use` blocks.
11551153
1156 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1154 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
11571155
11581156 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
11591157
from line 1415
14171415
14181416 - `configs: optional BetaBrowserToolsetConfigs or null`
14191417
1420 Per-member configuration for `browser_toolset_20260801`: one
1421 optional field per member tool, keyed by the member name — the same
1422 name the member's `tool_use` blocks carry. Every member is an
1423 accepted key, and a member's defaults apply wherever its key is
1424 absent. Unknown keys are rejected: the field set is this toolset
1425 version's complete member set.
1418 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
14261419
14271420 - `type: optional BetaBrowserTypeConfig or null`
14281421
from line 2036
20432036
20442037 - `configs: optional BetaComputerToolsetConfigs or null`
20452038
2046 Per-member configuration for `computer_toolset_20260801`: one
2047 optional field per member tool, keyed by the member name — the same
2048 name the member's `tool_use` blocks carry. Every member is an
2049 accepted key, and a member's defaults apply wherever its key is
2050 absent. Unknown keys are rejected: the field set is this toolset
2051 version's complete member set.
2039 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
20522040
20532041 - `type: optional BetaComputerTypeConfig or null`
20542042
from line 2390
24022390
24032391 Maximum number of times the tool can be used in the API request.
24042392
2405 exclusiveMinimum: 0
2393 minimum: 1
24062394
24072395 - `strict: optional boolean`
24082396
from line 2406
24182406
24192407 The city of the user.
24202408
2421 maxLength: 255, minLength: 1
2409 minLength: 1, maxLength: 255
24222410
24232411 - `country: optional string or null`
24242412
24252413 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
24262414
2427 maxLength: 2, minLength: 2
2415 minLength: 2, maxLength: 2
24282416
24292417 - `region: optional string or null`
24302418
24312419 The region of the user.
24322420
2433 maxLength: 255, minLength: 1
2421 minLength: 1, maxLength: 255
24342422
24352423 - `timezone: optional string or null`
24362424
24372425 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
24382426
2439 maxLength: 255, minLength: 1
2427 minLength: 1, maxLength: 255
24402428
24412429 - `BetaWebFetchTool20250910 object`
24422430
from line 2472
24842472
24852473 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
24862474
2487 exclusiveMinimum: 0
2475 minimum: 1
24882476
24892477 - `max_uses: optional number or null`
24902478
24912479 Maximum number of times the tool can be used in the API request.
24922480
2493 exclusiveMinimum: 0
2481 minimum: 1
24942482
24952483 - `strict: optional boolean`
24962484
from line 2486
24982486
24992487 - `url_sources: optional BetaWebFetchURLSources or null`
25002488
2501 Which sources contribute to the set of URLs web fetch may fetch.
2489 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
25022490
2503 Each key is a tagged variant: `user_input` is `all` or `none`; the
2504 two tool filters are `all`, `none`, `only` (only the named tools'
2505 results) or `except` (every result but the named tools'). A named tool
2506 must be declared in this request's `tools[]`.
2507
25082491 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
25092492
25102493 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2610
26272610
26282611 Maximum number of times the tool can be used in the API request.
26292612
2630 exclusiveMinimum: 0
2613 minimum: 1
26312614
26322615 - `strict: optional boolean`
26332616
from line 2664
26812664
26822665 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
26832666
2684 exclusiveMinimum: 0
2667 minimum: 1
26852668
26862669 - `max_uses: optional number or null`
26872670
26882671 Maximum number of times the tool can be used in the API request.
26892672
2690 exclusiveMinimum: 0
2673 minimum: 1
26912674
26922675 - `strict: optional boolean`
26932676
from line 2678
26952678
26962679 - `url_sources: optional BetaWebFetchURLSources or null`
26972680
2698 Which sources contribute to the set of URLs web fetch may fetch.
2681 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
26992682
2700 Each key is a tagged variant: `user_input` is `all` or `none`; the
2701 two tool filters are `all`, `none`, `only` (only the named tools'
2702 results) or `except` (every result but the named tools'). A named tool
2703 must be declared in this request's `tools[]`.
2704
27052683 - `BetaWebFetchTool20260309 object`
27062684
27072685 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2726
27482726
27492727 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
27502728
2751 exclusiveMinimum: 0
2729 minimum: 1
27522730
27532731 - `max_uses: optional number or null`
27542732
27552733 Maximum number of times the tool can be used in the API request.
27562734
2757 exclusiveMinimum: 0
2735 minimum: 1
27582736
27592737 - `strict: optional boolean`
27602738
from line 2740
27622740
27632741 - `url_sources: optional BetaWebFetchURLSources or null`
27642742
2765 Which sources contribute to the set of URLs web fetch may fetch.
2743 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27662744
2767 Each key is a tagged variant: `user_input` is `all` or `none`; the
2768 two tool filters are `all`, `none`, `only` (only the named tools'
2769 results) or `except` (every result but the named tools'). A named tool
2770 must be declared in this request's `tools[]`.
2771
27722745 - `use_cache: optional boolean`
27732746
27742747 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 2786
28132786
28142787 Maximum number of times the tool can be used in the API request.
28152788
2816 exclusiveMinimum: 0
2789 minimum: 1
28172790
28182791 - `response_inclusion: optional "full" or "excluded"`
28192792
from line 2848
28752848
28762849 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
28772850
2878 exclusiveMinimum: 0
2851 minimum: 1
28792852
28802853 - `max_uses: optional number or null`
28812854
28822855 Maximum number of times the tool can be used in the API request.
28832856
2884 exclusiveMinimum: 0
2857 minimum: 1
28852858
28862859 - `response_inclusion: optional "full" or "excluded"`
28872860
from line 2870
28972870
28982871 - `url_sources: optional BetaWebFetchURLSources or null`
28992872
2900 Which sources contribute to the set of URLs web fetch may fetch.
2873 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29012874
2902 Each key is a tagged variant: `user_input` is `all` or `none`; the
2903 two tool filters are `all`, `none`, `only` (only the named tools'
2904 results) or `except` (every result but the named tools'). A named tool
2905 must be declared in this request's `tools[]`.
2906
29072875 - `use_cache: optional boolean`
29082876
29092877 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 2886
29182886
29192887 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
29202888
2889 - `string`
2890
29212891 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
29222892
29232893 The model that will complete your prompt.
from line 2930
29602930
29612931 Powerful intelligence for long-running agents and coding
29622932
2963 - `"claude-mythos-preview"`
2964
2965 New class of intelligence, strongest in coding and cybersecurity
2966
29672933 - `"claude-opus-4-6"`
29682934
29692935 Powerful intelligence for long-running agents and coding
from line 2962
29962962
29972963 High-performance model for agents and coding
29982964
2999 - `string`
2965 - `"claude-mythos-preview"`
30002966
2967 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
2968
2969 New class of intelligence, strongest in coding and cybersecurity
2970
30012971 - `name: "advisor"`
30022972
30032973 Name of the tool.
from line 3006
30363006
30373007 Maximum number of times the tool can be used in the API request.
30383008
3039 exclusiveMinimum: 0
3009 minimum: 1
30403010
30413011 - `strict: optional boolean`
30423012
from line 3097
31273097
31283098 Name of the MCP server to configure tools for
31293099
3130 maxLength: 255, minLength: 1
3100 minLength: 1, maxLength: 255
31313101
31323102 - `cache_control: optional BetaCacheControlEphemeral or null`
31333103
from line 3212
32423212
32433213 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
32443214
3245 The policy category that triggered a refusal.
3215 The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`.
32463216
32473217 - `"cyber"`
32483218
from line 3307
33373307
33383308 - `diagnostics: BetaDiagnostics or null`
33393309
3340 Request-level diagnostics: why the prompt cache could not fully reuse
3341 the prefix of the request named by `diagnostics.previous_message_id`.
3310 Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected.
33423311
33433312 - `cache_miss_reason: BetaCacheMissReason or null`
33443313
from line 3381
34123381
34133382 - `stop_details: BetaRefusalStopDetails or null`
34143383
3415 Structured information about a refusal.
3384 Structured information about why model output stopped.
34163385
3386 This is `null` when the `stop_reason` has no additional detail to report.
3387
34173388 - `type: "refusal"`
34183389
34193390 default: refusal
from line 3391
34203391
34213392 - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null`
34223393
3423 The policy category that triggered a refusal.
3394 The policy category that triggered the refusal.
34243395
3396 `null` when the refusal doesn't map to a named category.
3397
34253398 - `"cyber"`
34263399
34273400 The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.
from line 3552
35793552
35803553 Outcome of the `fallback_credit_token` presented on this request.
35813554
3555 Present on every response to a non-batch request that carried a
3556 `fallback_credit_token`, in either redemption mode; absent otherwise (batch
3557 items accept and ignore the token and carry no outcome object).
3558
35823559 - `status: BetaFallbackCreditRedeemed or BetaFallbackCreditNotApplied`
35833560
35843561 Whether the fallback-credit reprice was applied to this response's billing.
from line 3879
39023879
39033880 - `speed: "standard" or "fast" or null`
39043881
3905 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3882 The inference speed mode used for this request.
39063883
39073884 - `"standard"`
39083885
api/beta/messages/count_tokens Changed · +93 / -132 lines
from line 231
231231
232232 - `document_title: string or null`
233233
234 maxLength: 500, minLength: 1
234 minLength: 1, maxLength: 500
235235
236236 - `end_char_index: number`
237237
from line 251
251251
252252 - `document_title: string or null`
253253
254 maxLength: 500, minLength: 1
254 minLength: 1, maxLength: 500
255255
256256 - `end_page_number: number`
257257
from line 275
275275
276276 - `document_title: string or null`
277277
278 maxLength: 500, minLength: 1
278 minLength: 1, maxLength: 500
279279
280280 - `end_block_index: number`
281281
from line 299
299299
300300 - `title: string or null`
301301
302 maxLength: 512, minLength: 1
302 minLength: 1, maxLength: 512
303303
304304 - `url: string`
305305
from line 455
455455
456456 - `title: optional string or null`
457457
458 maxLength: 500, minLength: 1
458 minLength: 1, maxLength: 500
459459
460460 - `BetaSearchResultBlockParam object`
461461
from line 519
519519
520520 - `name: string`
521521
522 maxLength: 200, minLength: 1
522 minLength: 1, maxLength: 200
523523
524524 - `cache_control: optional BetaCacheControlEphemeral or null`
525525
from line 555
555555
556556 For a toolset member tool_use, the toolset family this member belongs to.
557557
558 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
558 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
559559
560560 - `BetaToolResultBlockParam object`
561561
from line 591
591591
592592 - `tool_name: string`
593593
594 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
594 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
595595
596596 - `cache_control: optional BetaCacheControlEphemeral or null`
597597
from line 619
619619
620620 The caller-assigned identifier for this tab, unique within the inventory.
621621
622 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
622 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
623623
624624 - `title: string`
625625
from line 645
645645
646646 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
647647
648 maxItems: 200, minItems: 1
648 minItems: 1, maxItems: 200
649649
650650 - `BetaBrowserStateChangeTabOpened object`
651651
from line 663
663663
664664 The `tab_id` of the opened tab, present in `tabs`.
665665
666 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
666 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
667667
668668 - `BetaBrowserStateChangeDownloadStarted object`
669669
from line 675
675675
676676 The caller-assigned identifier for this download, stable across the state changes reporting it.
677677
678 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
678 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
679679
680680 - `url: string`
681681
from line 696
696696
697697 The caller-assigned identifier for this download, stable across the state changes reporting it.
698698
699 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
699 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
700700
701701 - `url: string`
702702
from line 708
708708
709709 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
710710
711 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
711 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
712712
713713 - `size_bytes: optional number or null`
714714
from line 726
726726
727727 The caller-assigned identifier for this download, stable across the state changes reporting it.
728728
729 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
729 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
730730
731731 - `url: string`
732732
from line 738
738738
739739 The failure or cancellation detail, when known.
740740
741 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
741 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
742742
743743 - `is_error: optional boolean`
744744
from line 746
746746
747747 For a toolset member tool_result, the toolset family of the paired tool_use.
748748
749 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
749 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
750750
751751 - `BetaServerToolUseBlockParam object`
752752
from line 1178
11781178
11791179 - `tool_name: string`
11801180
1181 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1181 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
11821182
11831183 - `cache_control: optional BetaCacheControlEphemeral or null`
11841184
from line 1370
13701370
13711371 This is how the tool will be called by the model and in `tool_use` blocks.
13721372
1373 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1373 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
13741374
13751375 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
13761376
from line 1621
16211621
16221622 - `configs: optional BetaBrowserToolsetConfigs or null`
16231623
1624 Per-member configuration for `browser_toolset_20260801`: one
1625 optional field per member tool, keyed by the member name — the same
1626 name the member's `tool_use` blocks carry. Every member is an
1627 accepted key, and a member's defaults apply wherever its key is
1628 absent. Unknown keys are rejected: the field set is this toolset
1629 version's complete member set.
1624 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
16301625
16311626 - `type: optional BetaBrowserTypeConfig or null`
16321627
from line 2242
22472242
22482243 - `configs: optional BetaComputerToolsetConfigs or null`
22492244
2250 Per-member configuration for `computer_toolset_20260801`: one
2251 optional field per member tool, keyed by the member name — the same
2252 name the member's `tool_use` blocks carry. Every member is an
2253 accepted key, and a member's defaults apply wherever its key is
2254 absent. Unknown keys are rejected: the field set is this toolset
2255 version's complete member set.
2245 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
22562246
22572247 - `type: optional BetaComputerTypeConfig or null`
22582248
from line 2596
26062596
26072597 Maximum number of times the tool can be used in the API request.
26082598
2609 exclusiveMinimum: 0
2599 minimum: 1
26102600
26112601 - `strict: optional boolean`
26122602
from line 2612
26222612
26232613 The city of the user.
26242614
2625 maxLength: 255, minLength: 1
2615 minLength: 1, maxLength: 255
26262616
26272617 - `country: optional string or null`
26282618
26292619 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
26302620
2631 maxLength: 2, minLength: 2
2621 minLength: 2, maxLength: 2
26322622
26332623 - `region: optional string or null`
26342624
26352625 The region of the user.
26362626
2637 maxLength: 255, minLength: 1
2627 minLength: 1, maxLength: 255
26382628
26392629 - `timezone: optional string or null`
26402630
26412631 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
26422632
2643 maxLength: 255, minLength: 1
2633 minLength: 1, maxLength: 255
26442634
26452635 - `BetaWebFetchTool20250910 object`
26462636
from line 2676
26862676
26872677 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
26882678
2689 exclusiveMinimum: 0
2679 minimum: 1
26902680
26912681 - `max_uses: optional number or null`
26922682
26932683 Maximum number of times the tool can be used in the API request.
26942684
2695 exclusiveMinimum: 0
2685 minimum: 1
26962686
26972687 - `strict: optional boolean`
26982688
from line 2690
27002690
27012691 - `url_sources: optional BetaWebFetchURLSources or null`
27022692
2703 Which sources contribute to the set of URLs web fetch may fetch.
2693 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27042694
2705 Each key is a tagged variant: `user_input` is `all` or `none`; the
2706 two tool filters are `all`, `none`, `only` (only the named tools'
2707 results) or `except` (every result but the named tools'). A named tool
2708 must be declared in this request's `tools[]`.
2709
27102695 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
27112696
27122697 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2814
28292814
28302815 Maximum number of times the tool can be used in the API request.
28312816
2832 exclusiveMinimum: 0
2817 minimum: 1
28332818
28342819 - `strict: optional boolean`
28352820
from line 2868
28832868
28842869 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
28852870
2886 exclusiveMinimum: 0
2871 minimum: 1
28872872
28882873 - `max_uses: optional number or null`
28892874
28902875 Maximum number of times the tool can be used in the API request.
28912876
2892 exclusiveMinimum: 0
2877 minimum: 1
28932878
28942879 - `strict: optional boolean`
28952880
from line 2882
28972882
28982883 - `url_sources: optional BetaWebFetchURLSources or null`
28992884
2900 Which sources contribute to the set of URLs web fetch may fetch.
2885 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29012886
2902 Each key is a tagged variant: `user_input` is `all` or `none`; the
2903 two tool filters are `all`, `none`, `only` (only the named tools'
2904 results) or `except` (every result but the named tools'). A named tool
2905 must be declared in this request's `tools[]`.
2906
29072887 - `BetaWebFetchTool20260309 object`
29082888
29092889 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2930
29502930
29512931 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29522932
2953 exclusiveMinimum: 0
2933 minimum: 1
29542934
29552935 - `max_uses: optional number or null`
29562936
29572937 Maximum number of times the tool can be used in the API request.
29582938
2959 exclusiveMinimum: 0
2939 minimum: 1
29602940
29612941 - `strict: optional boolean`
29622942
from line 2944
29642944
29652945 - `url_sources: optional BetaWebFetchURLSources or null`
29662946
2967 Which sources contribute to the set of URLs web fetch may fetch.
2947 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29682948
2969 Each key is a tagged variant: `user_input` is `all` or `none`; the
2970 two tool filters are `all`, `none`, `only` (only the named tools'
2971 results) or `except` (every result but the named tools'). A named tool
2972 must be declared in this request's `tools[]`.
2973
29742949 - `use_cache: optional boolean`
29752950
29762951 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 2990
30152990
30162991 Maximum number of times the tool can be used in the API request.
30172992
3018 exclusiveMinimum: 0
2993 minimum: 1
30192994
30202995 - `response_inclusion: optional "full" or "excluded"`
30212996
from line 3052
30773052
30783053 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
30793054
3080 exclusiveMinimum: 0
3055 minimum: 1
30813056
30823057 - `max_uses: optional number or null`
30833058
30843059 Maximum number of times the tool can be used in the API request.
30853060
3086 exclusiveMinimum: 0
3061 minimum: 1
30873062
30883063 - `response_inclusion: optional "full" or "excluded"`
30893064
from line 3074
30993074
31003075 - `url_sources: optional BetaWebFetchURLSources or null`
31013076
3102 Which sources contribute to the set of URLs web fetch may fetch.
3077 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
31033078
3104 Each key is a tagged variant: `user_input` is `all` or `none`; the
3105 two tool filters are `all`, `none`, `only` (only the named tools'
3106 results) or `except` (every result but the named tools'). A named tool
3107 must be declared in this request's `tools[]`.
3108
31093079 - `use_cache: optional boolean`
31103080
31113081 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3090
31203090
31213091 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31223092
3093 - `string`
3094
31233095 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
31243096
31253097 The model that will complete your prompt.
from line 3134
31623134
31633135 Powerful intelligence for long-running agents and coding
31643136
3165 - `"claude-mythos-preview"`
3166
3167 New class of intelligence, strongest in coding and cybersecurity
3168
31693137 - `"claude-opus-4-6"`
31703138
31713139 Powerful intelligence for long-running agents and coding
from line 3166
31983166
31993167 High-performance model for agents and coding
32003168
3201 - `string`
3169 - `"claude-mythos-preview"`
32023170
3171 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
3172
3173 New class of intelligence, strongest in coding and cybersecurity
3174
32033175 - `name: "advisor"`
32043176
32053177 Name of the tool.
from line 3210
32383210
32393211 Maximum number of times the tool can be used in the API request.
32403212
3241 exclusiveMinimum: 0
3213 minimum: 1
32423214
32433215 - `strict: optional boolean`
32443216
from line 3301
33293301
33303302 Name of the MCP server to configure tools for
33313303
3332 maxLength: 255, minLength: 1
3304 minLength: 1, maxLength: 255
33333305
33343306 - `cache_control: optional BetaCacheControlEphemeral or null`
33353307
from line 3411
34393411
34403412 The name of the MCP server this listing came from, as `mcp_servers` declares it.
34413413
3442 maxLength: 255, minLength: 1
3414 minLength: 1, maxLength: 255
34433415
34443416 - `tools: array of BetaMCPToolParam`
34453417
from line 3493
35213493
35223494 - `effort: optional "low" or "medium" or "high" or 2 more or null`
35233495
3524 All possible effort levels.
3496 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
35253497
3498 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3499
35263500 - `"low"`
35273501
35283502 - `"medium"`
from line 3519
35453519
35463520- `compaction: optional BetaCompactionConfig or null`
35473521
3548 Compact the whole conversation and return a signed `compaction` block,
3549 alone, that a later request sends back first in `messages`, in place of
3550 the messages it summarizes. There is no trigger and no pause flag: sending
3551 the parameter compacts, and nothing is sampled after the block.
3522 Compaction configuration.
35523523
3553 The summarization prompt is the server's own unless `instructions` are
3554 given, which then replace it for this request; a value that is empty or
3555 only whitespace counts as absent.
3524 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
35563525
35573526 - `type: "summarize"`
35583527
from line 3541
35723541
35733542 List of context management edits to apply
35743543
3575 minItems: 0
3576
35773544 - `BetaClearToolUses20250919Edit object`
35783545
35793546 - `type: "clear_tool_uses_20250919"`
from line 3663
36963663
36973664 - `effort: optional "low" or "medium" or "high" or 2 more or null`
36983665
3699 All possible effort levels.
3666 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
37003667
3668 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3669
37013670 - `"low"`
37023671
37033672 - `"medium"`
from line 3689
37203689
37213690 - `task_budget: optional BetaTokenTaskBudget or null`
37223691
3723 User-configurable total token budget across contexts.
3692 Configuration for token budget tracking across contexts.
37243693
37253694 - `type: "tokens"`
37263695
from line 3709
37403709
37413710- `speed: optional "standard" or "fast" or null`
37423711
3743 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3712 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
37443713
37453714 - `"standard"`
37463715
from line 3761
37923761
37933762 - `block_binding: optional BetaThinkingBlockBinding or null`
37943763
3795 Controls for block binding: what happens when a thinking block this
3796 request sends back fails the conversation check. Every field is optional;
3797 an empty object means every default.
3764 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
37983765
37993766 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
38003767
3801 What happens when a thinking block in `messages` fails the conversation
3802 check: it was created in a different conversation, or the messages before
3803 it have changed since. `"error"` (the default) fails the request with a
3804 400 error. `"drop_block"` removes the failing blocks and the request
3805 proceeds; the model no longer sees the dropped reasoning.
3768 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
38063769
38073770 - `"error"`
38083771
from line 3791
38283791
38293792 - `block_binding: optional BetaThinkingBlockBinding or null`
38303793
3831 Controls for block binding: what happens when a thinking block this
3832 request sends back fails the conversation check. Every field is optional;
3833 an empty object means every default.
3794 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
38343795
38353796 - `display: optional "summarized" or "omitted" or "updates" or null`
38363797
api/beta/messages/create Changed · +189 / -244 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.
from line 243
243243
244244 - `document_title: string or null`
245245
246 maxLength: 500, minLength: 1
246 minLength: 1, maxLength: 500
247247
248248 - `end_char_index: number`
249249
from line 263
263263
264264 - `document_title: string or null`
265265
266 maxLength: 500, minLength: 1
266 minLength: 1, maxLength: 500
267267
268268 - `end_page_number: number`
269269
from line 287
287287
288288 - `document_title: string or null`
289289
290 maxLength: 500, minLength: 1
290 minLength: 1, maxLength: 500
291291
292292 - `end_block_index: number`
293293
from line 311
311311
312312 - `title: string or null`
313313
314 maxLength: 512, minLength: 1
314 minLength: 1, maxLength: 512
315315
316316 - `url: string`
317317
from line 467
467467
468468 - `title: optional string or null`
469469
470 maxLength: 500, minLength: 1
470 minLength: 1, maxLength: 500
471471
472472 - `BetaSearchResultBlockParam object`
473473
from line 531
531531
532532 - `name: string`
533533
534 maxLength: 200, minLength: 1
534 minLength: 1, maxLength: 200
535535
536536 - `cache_control: optional BetaCacheControlEphemeral or null`
537537
from line 567
567567
568568 For a toolset member tool_use, the toolset family this member belongs to.
569569
570 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
570 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
571571
572572 - `BetaToolResultBlockParam object`
573573
from line 603
603603
604604 - `tool_name: string`
605605
606 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
606 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
607607
608608 - `cache_control: optional BetaCacheControlEphemeral or null`
609609
from line 631
631631
632632 The caller-assigned identifier for this tab, unique within the inventory.
633633
634 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
634 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
635635
636636 - `title: string`
637637
from line 657
657657
658658 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
659659
660 maxItems: 200, minItems: 1
660 minItems: 1, maxItems: 200
661661
662662 - `BetaBrowserStateChangeTabOpened object`
663663
from line 675
675675
676676 The `tab_id` of the opened tab, present in `tabs`.
677677
678 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
678 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
679679
680680 - `BetaBrowserStateChangeDownloadStarted object`
681681
from line 687
687687
688688 The caller-assigned identifier for this download, stable across the state changes reporting it.
689689
690 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
690 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
691691
692692 - `url: string`
693693
from line 708
708708
709709 The caller-assigned identifier for this download, stable across the state changes reporting it.
710710
711 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
711 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
712712
713713 - `url: string`
714714
from line 720
720720
721721 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
722722
723 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
723 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
724724
725725 - `size_bytes: optional number or null`
726726
from line 738
738738
739739 The caller-assigned identifier for this download, stable across the state changes reporting it.
740740
741 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
741 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
742742
743743 - `url: string`
744744
from line 750
750750
751751 The failure or cancellation detail, when known.
752752
753 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
753 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
754754
755755 - `is_error: optional boolean`
756756
from line 758
758758
759759 For a toolset member tool_result, the toolset family of the paired tool_use.
760760
761 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
761 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
762762
763763 - `BetaServerToolUseBlockParam object`
764764
from line 1190
11901190
11911191 - `tool_name: string`
11921192
1193 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1193 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
11941194
11951195 - `cache_control: optional BetaCacheControlEphemeral or null`
11961196
from line 1382
13821382
13831383 This is how the tool will be called by the model and in `tool_use` blocks.
13841384
1385 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
1385 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
13861386
13871387 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
13881388
from line 1633
16331633
16341634 - `configs: optional BetaBrowserToolsetConfigs or null`
16351635
1636 Per-member configuration for `browser_toolset_20260801`: one
1637 optional field per member tool, keyed by the member name — the same
1638 name the member's `tool_use` blocks carry. Every member is an
1639 accepted key, and a member's defaults apply wherever its key is
1640 absent. Unknown keys are rejected: the field set is this toolset
1641 version's complete member set.
1636 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
16421637
16431638 - `type: optional BetaBrowserTypeConfig or null`
16441639
from line 2254
22592254
22602255 - `configs: optional BetaComputerToolsetConfigs or null`
22612256
2262 Per-member configuration for `computer_toolset_20260801`: one
2263 optional field per member tool, keyed by the member name — the same
2264 name the member's `tool_use` blocks carry. Every member is an
2265 accepted key, and a member's defaults apply wherever its key is
2266 absent. Unknown keys are rejected: the field set is this toolset
2267 version's complete member set.
2257 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
22682258
22692259 - `type: optional BetaComputerTypeConfig or null`
22702260
from line 2608
26182608
26192609 Maximum number of times the tool can be used in the API request.
26202610
2621 exclusiveMinimum: 0
2611 minimum: 1
26222612
26232613 - `strict: optional boolean`
26242614
from line 2624
26342624
26352625 The city of the user.
26362626
2637 maxLength: 255, minLength: 1
2627 minLength: 1, maxLength: 255
26382628
26392629 - `country: optional string or null`
26402630
26412631 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
26422632
2643 maxLength: 2, minLength: 2
2633 minLength: 2, maxLength: 2
26442634
26452635 - `region: optional string or null`
26462636
26472637 The region of the user.
26482638
2649 maxLength: 255, minLength: 1
2639 minLength: 1, maxLength: 255
26502640
26512641 - `timezone: optional string or null`
26522642
26532643 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
26542644
2655 maxLength: 255, minLength: 1
2645 minLength: 1, maxLength: 255
26562646
26572647 - `BetaWebFetchTool20250910 object`
26582648
from line 2688
26982688
26992689 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
27002690
2701 exclusiveMinimum: 0
2691 minimum: 1
27022692
27032693 - `max_uses: optional number or null`
27042694
27052695 Maximum number of times the tool can be used in the API request.
27062696
2707 exclusiveMinimum: 0
2697 minimum: 1
27082698
27092699 - `strict: optional boolean`
27102700
from line 2702
27122702
27132703 - `url_sources: optional BetaWebFetchURLSources or null`
27142704
2715 Which sources contribute to the set of URLs web fetch may fetch.
2705 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
27162706
2717 Each key is a tagged variant: `user_input` is `all` or `none`; the
2718 two tool filters are `all`, `none`, `only` (only the named tools'
2719 results) or `except` (every result but the named tools'). A named tool
2720 must be declared in this request's `tools[]`.
2721
27222707 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
27232708
27242709 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 2826
28412826
28422827 Maximum number of times the tool can be used in the API request.
28432828
2844 exclusiveMinimum: 0
2829 minimum: 1
28452830
28462831 - `strict: optional boolean`
28472832
from line 2880
28952880
28962881 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
28972882
2898 exclusiveMinimum: 0
2883 minimum: 1
28992884
29002885 - `max_uses: optional number or null`
29012886
29022887 Maximum number of times the tool can be used in the API request.
29032888
2904 exclusiveMinimum: 0
2889 minimum: 1
29052890
29062891 - `strict: optional boolean`
29072892
from line 2894
29092894
29102895 - `url_sources: optional BetaWebFetchURLSources or null`
29112896
2912 Which sources contribute to the set of URLs web fetch may fetch.
2897 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29132898
2914 Each key is a tagged variant: `user_input` is `all` or `none`; the
2915 two tool filters are `all`, `none`, `only` (only the named tools'
2916 results) or `except` (every result but the named tools'). A named tool
2917 must be declared in this request's `tools[]`.
2918
29192899 - `BetaWebFetchTool20260309 object`
29202900
29212901 Web fetch tool with use_cache parameter for bypassing cached content.
from line 2942
29622942
29632943 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
29642944
2965 exclusiveMinimum: 0
2945 minimum: 1
29662946
29672947 - `max_uses: optional number or null`
29682948
29692949 Maximum number of times the tool can be used in the API request.
29702950
2971 exclusiveMinimum: 0
2951 minimum: 1
29722952
29732953 - `strict: optional boolean`
29742954
from line 2956
29762956
29772957 - `url_sources: optional BetaWebFetchURLSources or null`
29782958
2979 Which sources contribute to the set of URLs web fetch may fetch.
2959 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
29802960
2981 Each key is a tagged variant: `user_input` is `all` or `none`; the
2982 two tool filters are `all`, `none`, `only` (only the named tools'
2983 results) or `except` (every result but the named tools'). A named tool
2984 must be declared in this request's `tools[]`.
2985
29862961 - `use_cache: optional boolean`
29872962
29882963 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3002
30273002
30283003 Maximum number of times the tool can be used in the API request.
30293004
3030 exclusiveMinimum: 0
3005 minimum: 1
30313006
30323007 - `response_inclusion: optional "full" or "excluded"`
30333008
from line 3064
30893064
30903065 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
30913066
3092 exclusiveMinimum: 0
3067 minimum: 1
30933068
30943069 - `max_uses: optional number or null`
30953070
30963071 Maximum number of times the tool can be used in the API request.
30973072
3098 exclusiveMinimum: 0
3073 minimum: 1
30993074
31003075 - `response_inclusion: optional "full" or "excluded"`
31013076
from line 3086
31113086
31123087 - `url_sources: optional BetaWebFetchURLSources or null`
31133088
3114 Which sources contribute to the set of URLs web fetch may fetch.
3089 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
31153090
3116 Each key is a tagged variant: `user_input` is `all` or `none`; the
3117 two tool filters are `all`, `none`, `only` (only the named tools'
3118 results) or `except` (every result but the named tools'). A named tool
3119 must be declared in this request's `tools[]`.
3120
31213091 - `use_cache: optional boolean`
31223092
31233093 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 3102
31323102
31333103 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31343104
3105 - `string`
3106
31353107 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
31363108
31373109 The model that will complete your prompt.
from line 3146
31743146
31753147 Powerful intelligence for long-running agents and coding
31763148
3177 - `"claude-mythos-preview"`
3178
3179 New class of intelligence, strongest in coding and cybersecurity
3180
31813149 - `"claude-opus-4-6"`
31823150
31833151 Powerful intelligence for long-running agents and coding
from line 3178
32103178
32113179 High-performance model for agents and coding
32123180
3213 - `string`
3181 - `"claude-mythos-preview"`
32143182
3183 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
3184
3185 New class of intelligence, strongest in coding and cybersecurity
3186
32153187 - `name: "advisor"`
32163188
32173189 Name of the tool.
from line 3222
32503222
32513223 Maximum number of times the tool can be used in the API request.
32523224
3253 exclusiveMinimum: 0
3225 minimum: 1
32543226
32553227 - `strict: optional boolean`
32563228
from line 3313
33413313
33423314 Name of the MCP server to configure tools for
33433315
3344 maxLength: 255, minLength: 1
3316 minLength: 1, maxLength: 255
33453317
33463318 - `cache_control: optional BetaCacheControlEphemeral or null`
33473319
from line 3423
34513423
34523424 The name of the MCP server this listing came from, as `mcp_servers` declares it.
34533425
3454 maxLength: 255, minLength: 1
3426 minLength: 1, maxLength: 255
34553427
34563428 - `tools: array of BetaMCPToolParam`
34573429
from line 3505
35333505
35343506 - `effort: optional "low" or "medium" or "high" or 2 more or null`
35353507
3536 All possible effort levels.
3508 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
35373509
3510 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3511
35383512 - `"low"`
35393513
35403514 - `"medium"`
from line 3531
35573531
35583532- `compaction: optional BetaCompactionConfig or null`
35593533
3560 Compact the whole conversation and return a signed `compaction` block,
3561 alone, that a later request sends back first in `messages`, in place of
3562 the messages it summarizes. There is no trigger and no pause flag: sending
3563 the parameter compacts, and nothing is sampled after the block.
3534 Compaction configuration.
35643535
3565 The summarization prompt is the server's own unless `instructions` are
3566 given, which then replace it for this request; a value that is empty or
3567 only whitespace counts as absent.
3536 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
35683537
35693538 - `type: "summarize"`
35703539
from line 3573
36043573
36053574 Skill ID
36063575
3607 maxLength: 64, minLength: 1
3576 minLength: 1, maxLength: 64
36083577
36093578 - `version: optional string`
36103579
36113580 Skill version or 'latest' for most recent version
36123581
3613 maxLength: 64, minLength: 1
3582 minLength: 1, maxLength: 64
36143583
36153584 - `string`
36163585
from line 3593
36243593
36253594 List of context management edits to apply
36263595
3627 minItems: 0
3628
36293596 - `BetaClearToolUses20250919Edit object`
36303597
36313598 - `type: "clear_tool_uses_20250919"`
from line 3691
37243691
37253692- `diagnostics: optional BetaDiagnosticsParam or null`
37263693
3727 Request-level diagnostics. Currently carries the previous response
3728 id for prompt-cache divergence reporting.
3694 Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request.
37293695
37303696 - `previous_message_id: optional string or null`
37313697
from line 3738
37723738
37733739 The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.
37743740
3775 maxLength: 2048, minLength: 1
3741 minLength: 1, maxLength: 2048
37763742
37773743 - `mode: optional "strict" or "best_effort"`
37783744
from line 3766
38003766
38013767 - `effort: optional "low" or "medium" or "high" or 2 more or null`
38023768
3803 All possible effort levels.
3769 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
38043770
3771 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
3772
38053773 - `"low"`
38063774
38073775 - `"medium"`
from line 3792
38243792
38253793 - `task_budget: optional BetaTokenTaskBudget or null`
38263794
3827 User-configurable total token budget across contexts.
3795 Configuration for token budget tracking across contexts.
38283796
38293797 - `type: "tokens"`
38303798
from line 3836
38683836
38693837 - `block_binding: optional BetaThinkingBlockBinding or null`
38703838
3871 Controls for block binding: what happens when a thinking block this
3872 request sends back fails the conversation check. Every field is optional;
3873 an empty object means every default.
3839 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
38743840
38753841 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
38763842
3877 What happens when a thinking block in `messages` fails the conversation
3878 check: it was created in a different conversation, or the messages before
3879 it have changed since. `"error"` (the default) fails the request with a
3880 400 error. `"drop_block"` removes the failing blocks and the request
3881 proceeds; the model no longer sees the dropped reasoning.
3843 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
38823844
38833845 - `"error"`
38843846
from line 3866
39043866
39053867 - `block_binding: optional BetaThinkingBlockBinding or null`
39063868
3907 Controls for block binding: what happens when a thinking block this
3908 request sends back fails the conversation check. Every field is optional;
3909 an empty object means every default.
3869 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
39103870
39113871 - `display: optional "summarized" or "omitted" or "updates" or null`
39123872
from line 3932
39723932
39733933- `speed: optional "standard" or "fast" or null`
39743934
3975 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3935 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
39763936
39773937 - `"standard"`
39783938
from line 4201
42414201
42424202 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
42434203
4244 maximum: 1, minimum: 0
4204 minimum: 0, maximum: 1
42454205
42464206- `top_k: optional number`
42474207
from line 4225
42654225
42664226 Recommended for advanced use cases only.
42674227
4268 maximum: 1, minimum: 0
4228 minimum: 0, maximum: 1
42694229
42704230## Returns
42714231
from line 4247
42874247
42884248 - `container: BetaContainer or null`
42894249
4290 Information about the container used in the request (for the code execution tool)
4250 Information about the container used in this request.
42914251
4252 This will be non-null if a container tool (e.g. code execution) was used.
4253
42924254 - `id: string`
42934255
42944256 Identifier for the container used in this request
from line 4277
43154277
43164278 Skill ID
43174279
4318 maxLength: 64, minLength: 1
4280 minLength: 1, maxLength: 64
43194281
43204282 - `version: string`
43214283
43224284 The resolved version: a skill version ID for custom skills.
43234285
4324 maxLength: 64, minLength: 1
4286 minLength: 1, maxLength: 64
43254287
43264288 - `content: array of BetaContentBlock`
43274289
from line 4456
44944456
44954457 - `text: string`
44964458
4497 minLength: 0
4498
44994459 - `BetaThinkingBlock object`
45004460
45014461 - `type: "thinking"`
from line 4534
45744534
45754535 For a toolset member tool_use, the toolset family.
45764536
4577 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
4537 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
45784538
45794539 - `BetaServerToolUseBlock object`
45804540
from line 5038
50785038
50795039 - `tool_name: string`
50805040
5081 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
5041 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
50825042
50835043 - `tool_use_id: string`
50845044
from line 5088
51285088
51295089 - `text: string`
51305090
5131 minLength: 0
5132
51335091 - `is_error: boolean`
51345092
51355093 default: false
from line 5225
52675225
52685226 This is how the tool will be called by the model and in `tool_use` blocks.
52695227
5270 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
5228 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
52715229
52725230 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
52735231
from line 5489
55315489
55325490 - `configs: optional BetaBrowserToolsetConfigs or null`
55335491
5534 Per-member configuration for `browser_toolset_20260801`: one
5535 optional field per member tool, keyed by the member name — the same
5536 name the member's `tool_use` blocks carry. Every member is an
5537 accepted key, and a member's defaults apply wherever its key is
5538 absent. Unknown keys are rejected: the field set is this toolset
5539 version's complete member set.
5492 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
55405493
55415494 - `type: optional BetaBrowserTypeConfig or null`
55425495
from line 6110
61576110
61586111 - `configs: optional BetaComputerToolsetConfigs or null`
61596112
6160 Per-member configuration for `computer_toolset_20260801`: one
6161 optional field per member tool, keyed by the member name — the same
6162 name the member's `tool_use` blocks carry. Every member is an
6163 accepted key, and a member's defaults apply wherever its key is
6164 absent. Unknown keys are rejected: the field set is this toolset
6165 version's complete member set.
6113 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
61666114
61676115 - `type: optional BetaComputerTypeConfig or null`
61686116
from line 6464
65166464
65176465 Maximum number of times the tool can be used in the API request.
65186466
6519 exclusiveMinimum: 0
6467 minimum: 1
65206468
65216469 - `strict: optional boolean`
65226470
from line 6480
65326480
65336481 The city of the user.
65346482
6535 maxLength: 255, minLength: 1
6483 minLength: 1, maxLength: 255
65366484
65376485 - `country: optional string or null`
65386486
65396487 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
65406488
6541 maxLength: 2, minLength: 2
6489 minLength: 2, maxLength: 2
65426490
65436491 - `region: optional string or null`
65446492
65456493 The region of the user.
65466494
6547 maxLength: 255, minLength: 1
6495 minLength: 1, maxLength: 255
65486496
65496497 - `timezone: optional string or null`
65506498
65516499 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
65526500
6553 maxLength: 255, minLength: 1
6501 minLength: 1, maxLength: 255
65546502
65556503 - `BetaWebFetchTool20250910 object`
65566504
from line 6546
65986546
65996547 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
66006548
6601 exclusiveMinimum: 0
6549 minimum: 1
66026550
66036551 - `max_uses: optional number or null`
66046552
66056553 Maximum number of times the tool can be used in the API request.
66066554
6607 exclusiveMinimum: 0
6555 minimum: 1
66086556
66096557 - `strict: optional boolean`
66106558
from line 6560
66126560
66136561 - `url_sources: optional BetaWebFetchURLSources or null`
66146562
6615 Which sources contribute to the set of URLs web fetch may fetch.
6563 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
66166564
6617 Each key is a tagged variant: `user_input` is `all` or `none`; the
6618 two tool filters are `all`, `none`, `only` (only the named tools'
6619 results) or `except` (every result but the named tools'). A named tool
6620 must be declared in this request's `tools[]`.
6621
66226565 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
66236566
66246567 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 6684
67416684
67426685 Maximum number of times the tool can be used in the API request.
67436686
6744 exclusiveMinimum: 0
6687 minimum: 1
67456688
67466689 - `strict: optional boolean`
67476690
from line 6738
67956738
67966739 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
67976740
6798 exclusiveMinimum: 0
6741 minimum: 1
67996742
68006743 - `max_uses: optional number or null`
68016744
68026745 Maximum number of times the tool can be used in the API request.
68036746
6804 exclusiveMinimum: 0
6747 minimum: 1
68056748
68066749 - `strict: optional boolean`
68076750
from line 6752
68096752
68106753 - `url_sources: optional BetaWebFetchURLSources or null`
68116754
6812 Which sources contribute to the set of URLs web fetch may fetch.
6755 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
68136756
6814 Each key is a tagged variant: `user_input` is `all` or `none`; the
6815 two tool filters are `all`, `none`, `only` (only the named tools'
6816 results) or `except` (every result but the named tools'). A named tool
6817 must be declared in this request's `tools[]`.
6818
68196757 - `BetaWebFetchTool20260309 object`
68206758
68216759 Web fetch tool with use_cache parameter for bypassing cached content.
from line 6800
68626800
68636801 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
68646802
6865 exclusiveMinimum: 0
6803 minimum: 1
68666804
68676805 - `max_uses: optional number or null`
68686806
68696807 Maximum number of times the tool can be used in the API request.
68706808
6871 exclusiveMinimum: 0
6809 minimum: 1
68726810
68736811 - `strict: optional boolean`
68746812
from line 6814
68766814
68776815 - `url_sources: optional BetaWebFetchURLSources or null`
68786816
6879 Which sources contribute to the set of URLs web fetch may fetch.
6817 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
68806818
6881 Each key is a tagged variant: `user_input` is `all` or `none`; the
6882 two tool filters are `all`, `none`, `only` (only the named tools'
6883 results) or `except` (every result but the named tools'). A named tool
6884 must be declared in this request's `tools[]`.
6885
68866819 - `use_cache: optional boolean`
68876820
68886821 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 6860
69276860
69286861 Maximum number of times the tool can be used in the API request.
69296862
6930 exclusiveMinimum: 0
6863 minimum: 1
69316864
69326865 - `response_inclusion: optional "full" or "excluded"`
69336866
from line 6922
69896922
69906923 Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs.
69916924
6992 exclusiveMinimum: 0
6925 minimum: 1
69936926
69946927 - `max_uses: optional number or null`
69956928
69966929 Maximum number of times the tool can be used in the API request.
69976930
6998 exclusiveMinimum: 0
6931 minimum: 1
69996932
70006933 - `response_inclusion: optional "full" or "excluded"`
70016934
from line 6944
70116944
70126945 - `url_sources: optional BetaWebFetchURLSources or null`
70136946
7014 Which sources contribute to the set of URLs web fetch may fetch.
6947 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
70156948
7016 Each key is a tagged variant: `user_input` is `all` or `none`; the
7017 two tool filters are `all`, `none`, `only` (only the named tools'
7018 results) or `except` (every result but the named tools'). A named tool
7019 must be declared in this request's `tools[]`.
7020
70216949 - `use_cache: optional boolean`
70226950
70236951 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 6960
70326960
70336961 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
70346962
6963 - `string`
6964
70356965 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
70366966
70376967 The model that will complete your prompt.
from line 7004
70747004
70757005 Powerful intelligence for long-running agents and coding
70767006
7077 - `"claude-mythos-preview"`
7078
7079 New class of intelligence, strongest in coding and cybersecurity
7080
70817007 - `"claude-opus-4-6"`
70827008
70837009 Powerful intelligence for long-running agents and coding
from line 7036
71107036
71117037 High-performance model for agents and coding
71127038
7113 - `string`
7039 - `"claude-mythos-preview"`
71147040
7041 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
7042
7043 New class of intelligence, strongest in coding and cybersecurity
7044
71157045 - `name: "advisor"`
71167046
71177047 Name of the tool.
from line 7080
71507080
71517081 Maximum number of times the tool can be used in the API request.
71527082
7153 exclusiveMinimum: 0
7083 minimum: 1
71547084
71557085 - `strict: optional boolean`
71567086
from line 7116
71867116
71877117 - `defer_loading: optional boolean`
71887118
7189
7119 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7120
7121 - `strict: optional boolean`
7122
7123 When true, guarantees schema validation on tool names and inputs
7124
7125 - `BetaToolSearchToolRegex20251119 object`
7126
7127 - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"`
7128
7129 - `"tool_search_tool_regex_20251119"`
7130
7131 - `"tool_search_tool_regex"`
7132
7133 - `name: "tool_search_tool_regex"`
7134
7135 Name of the tool.
7136
7137 This is how the tool will be called by the model and in `tool_use` blocks.
7138
7139 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7140
7141 - `"direct"`
7142
7143 - `"code_execution_20250825"`
7144
7145 - `"code_execution_20260120"`
7146
7147 - `"code_execution_20260521"`
7148
7149 - `cache_control: optional BetaCacheControlEphemeral or null`
7150
7151 Create a cache control breakpoint at this content block.
7152
7153 - `defer_loading: optional boolean`
7154
7155 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7156
7157 - `strict: optional boolean`
7158
7159 When true, guarantees schema validation on tool names and inputs
7160
7161 - `BetaMCPToolset object`
7162
7163 Configuration for a group of tools from an MCP server.
7164
7165 Allows configuring enabled status and defer_loading for all tools
7166 from an MCP server, with optional per-tool overrides.
7167
7168 - `type: "mcp_toolset"`
7169
7170 - `mcp_server_name: string`
7171
7172 Name of the MCP server to configure tools for
7173
7174 minLength: 1, maxLength: 255
7175
7176 - `cache_control: optional BetaCacheControlEphemeral or null`
7177
7178 Create a cache control breakpoint at this content block.
7179
7180 - `configs: optional map[BetaMCPToolConfig] or null`
7181
7182 Configuration overrides for specific tools, keyed by tool name
7183
7184 - `defer_loading: optional boolean`
7185
7186 - `enabled: optional boolean`
7187
7188 - `default_config: optional BetaMCPToolDefaultConfig`
7189
7190 Default configuration applied to all tools from this server
7191
7192 - `defer_loading: optional boolean`
7193
7194 - `enabled: optional boolean`
7195
7196 - `tools: optional array of BetaMCPToolParam or null`
7197
7198 The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response.
7199
7200 - `input_schema: map[unknown]`
7201
7202 The tool's input schema as the MCP server lists it, verbatim.
7203
7204 - `name: st