One read of Claude Developer Platformapi-20261110T043707Z
343 pages moved out of 893 read.
Pages moved
343
significant first
Pages read
893
in this capture
Captured
04:37 UTC
Corpus hash
9b50913f24d5
corpus-hash
What this read moved
1-25 of 343, page 1 of 14This capture is too large to show at once. Changes 1-25 of 343 are below, significant first; the rest are on the following screens.
api/beta Changed · +1498 / -143 lines
### Beta Organization Not Enrolled In Beta Error Details ### Beta Unsupported Charset Error Details ### Sign Out User
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 9
99
1010### Anthropic Beta
1111
12- `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 52 more`
12- `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 53 more`
1313
1414 Beta names you can send in the `anthropic-beta` header.
1515
from line 121
121121
122122 - `"webhooks-2026-10-07"`
123123
124 - `"admin-user-sign-out-2026-10-08"`
125
124126 - `"message-threads-2026-08-12"`
125127
126128 - `"analytics-usage-cost-2026-08-24"`
from line 135
133135
134136 - `type: "api_error"`
135137
138 The broad category of the error.
139
136140 default: api_error
137141
138142 - `message: string`
139143
144 A human-readable explanation of the error. Its wording can change, so don't match on it.
145
140146 default: Internal server error
141147
142148### Beta Authentication Error
from line 151
145151
146152 - `type: "authentication_error"`
147153
154 The broad category of the error.
155
148156 default: authentication_error
149157
150158 - `message: string`
151159
160 A human-readable explanation of the error. Its wording can change, so don't match on it.
161
152162 default: Authentication error
153163
154164### Beta Billing Error
from line 167
157167
158168 - `type: "billing_error"`
159169
170 The broad category of the error.
171
160172 default: billing_error
161173
162174 - `message: string`
163175
176 A human-readable explanation of the error. Its wording can change, so don't match on it.
177
164178 default: Billing error
165179
166180### Beta Currency
from line 189
175189
176190 - `type: "invalid_request_error"`
177191
192 The broad category of the error.
193
178194 default: invalid_request_error
179195
180196 - `message: string`
181197
198 A human-readable explanation of the error. Its wording can change, so don't match on it.
199
182200 default: Invalid request
183201
184202 - `BetaAuthenticationError object`
from line 203
185203
186204 - `type: "authentication_error"`
187205
206 The broad category of the error.
207
188208 default: authentication_error
189209
190210 - `message: string`
191211
212 A human-readable explanation of the error. Its wording can change, so don't match on it.
213
192214 default: Authentication error
193215
194216 - `BetaBillingError object`
from line 217
195217
196218 - `type: "billing_error"`
197219
220 The broad category of the error.
221
198222 default: billing_error
199223
200224 - `message: string`
201225
226 A human-readable explanation of the error. Its wording can change, so don't match on it.
227
202228 default: Billing error
203229
204230 - `BetaPermissionError object`
from line 231
205231
206232 - `type: "permission_error"`
207233
234 The broad category of the error.
235
208236 default: permission_error
209237
210238 - `message: string`
211239
240 A human-readable explanation of the error. Its wording can change, so don't match on it.
241
212242 default: Permission denied
213243
214244 - `BetaNotFoundError object`
from line 245
215245
216246 - `type: "not_found_error"`
217247
248 The broad category of the error.
249
218250 default: not_found_error
219251
220252 - `message: string`
221253
254 A human-readable explanation of the error. Its wording can change, so don't match on it.
255
222256 default: Not found
223257
224258 - `BetaRateLimitError object`
from line 259
225259
226260 - `type: "rate_limit_error"`
227261
262 The broad category of the error.
263
228264 default: rate_limit_error
229265
230266 - `message: string`
231267
268 A human-readable explanation of the error. Its wording can change, so don't match on it.
269
232270 default: Rate limited
233271
234272 - `BetaGatewayTimeoutError object`
from line 273
235273
236274 - `type: "timeout_error"`
237275
276 The broad category of the error.
277
238278 default: timeout_error
239279
240280 - `message: string`
241281
282 A human-readable explanation of the error. Its wording can change, so don't match on it.
283
242284 default: Request timeout
243285
244286 - `BetaAPIError object`
from line 287
245287
246288 - `type: "api_error"`
247289
290 The broad category of the error.
291
248292 default: api_error
249293
250294 - `message: string`
251295
296 A human-readable explanation of the error. Its wording can change, so don't match on it.
297
252298 default: Internal server error
253299
254300 - `BetaOverloadedError object`
from line 301
255301
256302 - `type: "overloaded_error"`
257303
304 The broad category of the error.
305
258306 default: overloaded_error
259307
260308 - `message: string`
261309
310 A human-readable explanation of the error. Its wording can change, so don't match on it.
311
262312 default: Overloaded
263313
264314### Beta Error Response
from line 325
275325
276326 - `type: "invalid_request_error"`
277327
328 The broad category of the error.
329
278330 default: invalid_request_error
279331
280332 - `message: string`
281333
334 A human-readable explanation of the error. Its wording can change, so don't match on it.
335
282336 default: Invalid request
283337
284338 - `BetaAuthenticationError object`
from line 339
285339
286340 - `type: "authentication_error"`
287341
342 The broad category of the error.
343
288344 default: authentication_error
289345
290346 - `message: string`
291347
348 A human-readable explanation of the error. Its wording can change, so don't match on it.
349
292350 default: Authentication error
293351
294352 - `BetaBillingError object`
from line 353
295353
296354 - `type: "billing_error"`
297355
356 The broad category of the error.
357
298358 default: billing_error
299359
300360 - `message: string`
301361
362 A human-readable explanation of the error. Its wording can change, so don't match on it.
363
302364 default: Billing error
303365
304366 - `BetaPermissionError object`
from line 367
305367
306368 - `type: "permission_error"`
307369
370 The broad category of the error.
371
308372 default: permission_error
309373
310374 - `message: string`
311375
376 A human-readable explanation of the error. Its wording can change, so don't match on it.
377
312378 default: Permission denied
313379
314380 - `BetaNotFoundError object`
from line 381
315381
316382 - `type: "not_found_error"`
317383
384 The broad category of the error.
385
318386 default: not_found_error
319387
320388 - `message: string`
321389
390 A human-readable explanation of the error. Its wording can change, so don't match on it.
391
322392 default: Not found
323393
324394 - `BetaRateLimitError object`
from line 395
325395
326396 - `type: "rate_limit_error"`
327397
398 The broad category of the error.
399
328400 default: rate_limit_error
329401
330402 - `message: string`
331403
404 A human-readable explanation of the error. Its wording can change, so don't match on it.
405
332406 default: Rate limited
333407
334408 - `BetaGatewayTimeoutError object`
from line 409
335409
336410 - `type: "timeout_error"`
337411
412 The broad category of the error.
413
338414 default: timeout_error
339415
340416 - `message: string`
341417
418 A human-readable explanation of the error. Its wording can change, so don't match on it.
419
342420 default: Request timeout
343421
344422 - `BetaAPIError object`
from line 423
345423
346424 - `type: "api_error"`
347425
426 The broad category of the error.
427
348428 default: api_error
349429
350430 - `message: string`
351431
432 A human-readable explanation of the error. Its wording can change, so don't match on it.
433
352434 default: Internal server error
353435
354436 - `BetaOverloadedError object`
from line 437
355437
356438 - `type: "overloaded_error"`
357439
440 The broad category of the error.
441
358442 default: overloaded_error
359443
360444 - `message: string`
361445
446 A human-readable explanation of the error. Its wording can change, so don't match on it.
447
362448 default: Overloaded
363449
364450 - `request_id: string or null`
from line 455
369455
370456 - `type: "timeout_error"`
371457
458 The broad category of the error.
459
372460 default: timeout_error
373461
374462 - `message: string`
375463
464 A human-readable explanation of the error. Its wording can change, so don't match on it.
465
376466 default: Request timeout
377467
378468### Beta Invalid Request Error
from line 471
381471
382472 - `type: "invalid_request_error"`
383473
474 The broad category of the error.
475
384476 default: invalid_request_error
385477
386478 - `message: string`
387479
480 A human-readable explanation of the error. Its wording can change, so don't match on it.
481
388482 default: Invalid request
389483
390484### Beta Monetary Amount
from line 503
409503
410504 - `type: "not_found_error"`
411505
506 The broad category of the error.
507
412508 default: not_found_error
413509
414510 - `message: string`
415511
512 A human-readable explanation of the error. Its wording can change, so don't match on it.
513
416514 default: Not found
417515
516### Beta Organization Not Enrolled In Beta Error Details
517
518- `BetaOrganizationNotEnrolledInBetaErrorDetails object`
519
520 The beta that the endpoint requires is not enabled for the organization. The message names the beta value.
521
522 - `error_code: "organization_not_enrolled_in_beta"`
523
418524### Beta Overloaded Error
419525
420526- `BetaOverloadedError object`
from line 527
421527
422528 - `type: "overloaded_error"`
423529
530 The broad category of the error.
531
424532 default: overloaded_error
425533
426534 - `message: string`
427535
536 A human-readable explanation of the error. Its wording can change, so don't match on it.
537
428538 default: Overloaded
429539
430540### Beta Permission Error
from line 543
433543
434544 - `type: "permission_error"`
435545
546 The broad category of the error.
547
436548 default: permission_error
437549
438550 - `message: string`
439551
552 A human-readable explanation of the error. Its wording can change, so don't match on it.
553
440554 default: Permission denied
441555
442556### Beta Rate Limit Error
from line 559
445559
446560 - `type: "rate_limit_error"`
447561
562 The broad category of the error.
563
448564 default: rate_limit_error
449565
450566 - `message: string`
451567
568 A human-readable explanation of the error. Its wording can change, so don't match on it.
569
452570 default: Rate limited
453571
572### Beta Unsupported Charset Error Details
573
574- `BetaUnsupportedCharsetErrorDetails object`
575
576 The request's `Content-Type` header names a charset other than UTF-8, ISO-8859-1 or US-ASCII. Send the request with no charset, or with one of these.
577
578 - `error_code: "unsupported_charset"`
579
454580## Beta › Models
455581
456582### List Models
from line 735
609735
610736 - `"webhooks-2026-10-07"`
611737
738 - `"admin-user-sign-out-2026-10-08"`
739
612740 - `"message-threads-2026-08-12"`
613741
614742 - `"analytics-usage-cost-2026-08-24"`
from line 1226
10981226
10991227 - `"webhooks-2026-10-07"`
11001228
1229 - `"admin-user-sign-out-2026-10-08"`
1230
11011231 - `"message-threads-2026-08-12"`
11021232
11031233 - `"analytics-usage-cost-2026-08-24"`
from line 1696
15661696
15671697 - `"webhooks-2026-10-07"`
15681698
1699 - `"admin-user-sign-out-2026-10-08"`
1700
15691701 - `"message-threads-2026-08-12"`
15701702
15711703 - `"analytics-usage-cost-2026-08-24"`
from line 4693
45614693
45624694 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
45634695
4696 - `"claude-fable-5-2"`
4697
4698 Built for the most ambitious work in coding, enterprise workflows, and the sciences
4699
4700 - `"claude-mythos-5-2"`
4701
4702 Built for the most demanding cybersecurity and life sciences research, available through verification programs
4703
45644704 - `"claude-haiku-5-5"`
45654705
45664706 Fastest model for high-volume, real-time tasks
from line 5051
49115051 Accepted in `messages[].content` and not rendered into the prompt; not
49125052 validated against the request's `fallbacks` chain or top-level `model`.
49135053
4914 Echo the assistant turn back verbatim, including this block in its
5054 When you send the assistant turn back, keep this block in its
49155055 original position. The block marks the boundary between content produced
49165056 before and after a fallback hop, and the server relies on that boundary
49175057 to validate the turn: when thinking runs flank the boundary, omitting
from line 5058
49185058 the block merges them into one span the server cannot validate (the
49195059 request is rejected), and moving it into the middle of a single run is
49205060 likewise rejected; between non-thinking blocks the block's placement has
4921 no validation effect.
5061 no effect on thinking validation.
49225062
5063 Some blocks from before the turn's final `fallback` block must be left
5064 out when you send the turn back, and no `tool_result` is sent for a
5065 `tool_use` block you left out.
5066
5067 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
5068
49235069 - `type: "fallback"`
49245070
49255071 - `from: BetaFallbackInfoParam`
from line 7606
74607606
74617607 Create a cache control breakpoint at this content block.
74627608
7463 - `defer_loading: optional boolean`
7464
7465 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7466
7467 - `input_examples: optional array of map[unknown]`
7468
7469 - `strict: optional boolean`
7470
7471 When true, guarantees schema validation on tool names and inputs
7472
7473 - `BetaToolComputerUse20250124 object`
7474
7475 - `type: "computer_20250124"`
7476
7477 - `display_height_px: number`
7478
7479 The height of the display in pixels.
7480
7481 minimum: 1
7482
7483 - `display_width_px: number`
7484
7485 The width of the display in pixels.
7486
7487 minimum: 1
7488
7489 - `name: "computer"`
7490
7491 Name of the tool.
7492
7493 This is how the tool will be called by the model and in `tool_use` blocks.
7494
7495 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7496
7497 - `"direct"`
7498
7499 - `"code_execution_20250825"`
7500
7501 - `"code_execution_20260120"`
7502
7503 - `"code_execution_20260521"`
7504
7505 - `cache_control: optional BetaCacheControlEphemeral or null`
7506
7507 Create a cache control breakpoint at this content block.
7508
7509 - `defer_loading: optional boolean`
7510
7511 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7512
7513 - `display_number: optional number or null`
7514
7515 The X11 display number (e.g. 0, 1) for the display.
7516
7517 minimum: 0
7518
7519 - `input_examples: optional array of map[unknown]`
7520
7521 - `strict: optional boolean`
7522
7523 When true, guarantees schema validation on tool names and inputs
7524
7525 - `BetaToolTextEditor20241022 object`
7526
7527 - `type: "text_editor_20241022"`
7528
7529 - `name: "str_replace_editor"`
7530
7531 Name of the tool.
7532
7533 This is how the tool will be called by the model and in `tool_use` blocks.
7534
7535 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7536
7537 - `"direct"`
7538
7539 - `"code_execution_20250825"`
7540
7541 - `"code_execution_20260120"`
7542
7543 - `"code_execution_20260521"`
7544
7545 - `cache_control: optional BetaCacheControlEphemeral or null`
7546
7547 Create a cache control breakpoint at this content block.
7548
7549 - `defer_loading: optional boolean`
7550
7551 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7552
7553 - `input_examples: optional array of map[unknown]`
7554
7555 - `strict: optional boolean`
7556
7557 When true, guarantees schema validation on tool names and inputs
7558
7559 - `BetaToolComputerUse20251124 object`
7560
7561 - `type: "computer_20251124"`
7562
7563 - `display_height_px: number`
7564
7565 The height of the display in pixels.
7566
7567 minimum: 1
7568
7569 - `display_width_px: number`
7570
7571 The width of the display in pixels.
7572
7573 minimum: 1
7574
7575 - `name: "computer"`
7576
7577 Name of the tool.
7578
7579 This is how the tool will be called by the model and in `tool_use` blocks.
7580
7581 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
7582
7583 - `"direct"`
7584
7585 - `"code_execution_20250825"`
7586
7587 - `"code_execution_20260120"`
7588
7589 - `"code_execution_20260521"`
7590
7591 - `cache_control: optional BetaCacheControlEphemeral or null`
7592
7593 Create a cache control breakpoint at this content block.
7594
7595 - `defer_loading: optional boolean`
7596
7597 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7598
7599 - `display_number: optional number or null`
7600
7601 The X11 display number (e.g. 0, 1) for the display.
7602
7603 minimum: 0
7604
7605 - `enable_zoom: optional boolean`
7606
7607 Whether to enable an action to take a zoomed-in screenshot of the screen.
7608
7609 - `input_examples: optional array of map[unknown]`
7610
7611 - `strict: optional boolean`
7612
7613 When true, guarantees schema validation on tool names and inputs
7614
7615 - `BetaComputerToolset20260801 object`
7616
7617 The computer toolset: a single `tools[]` entry (carrying no
7618 `name`) that declares
7609 - `
api/beta/agents Changed · +73 / -3 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 129
129129
130130 - `"webhooks-2026-10-07"`
131131
132 - `"admin-user-sign-out-2026-10-08"`
133
132134 - `"message-threads-2026-08-12"`
133135
134136 - `"analytics-usage-cost-2026-08-24"`
from line 149
147149
148150 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control
149151
150 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
152 - `BetaManagedAgentsModel = "claude-fable-5-2" or "claude-haiku-5-5" or "claude-sonnet-5-5" or 15 more or string`
151153
152154 The model that will power your agent.
153155
154156 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
155157
158 - `"claude-fable-5-2"`
159
160 Built for the most ambitious work in coding, enterprise workflows, and the sciences
161
156162 - `"claude-haiku-5-5"`
157163
158164 Fastest model for high-volume, real-time tasks
from line 1159
11531159
11541160 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
11551161
1162 - `"claude-fable-5-2"`
1163
1164 Built for the most ambitious work in coding, enterprise workflows, and the sciences
1165
11561166 - `"claude-haiku-5-5"`
11571167
11581168 Fastest model for high-volume, real-time tasks
from line 1904
18941904 "metadata": {
18951905 "foo": "bar"
18961906 },
1907 "multiagent": {
1908 "type": "multiagent_20261001",
1909 "workflows": {
1910 "type": "enabled"
1911 }
1912 },
18971913 "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user'\''s task end to end.",
18981914 "tools": [
18991915 {
from line 2173
21572173
21582174 - `"webhooks-2026-10-07"`
21592175
2176 - `"admin-user-sign-out-2026-10-08"`
2177
21602178 - `"message-threads-2026-08-12"`
21612179
21622180 - `"analytics-usage-cost-2026-08-24"`
from line 2251
22332251
22342252 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
22352253
2254 - `"claude-fable-5-2"`
2255
2256 Built for the most ambitious work in coding, enterprise workflows, and the sciences
2257
22362258 - `"claude-haiku-5-5"`
22372259
22382260 Fastest model for high-volume, real-time tasks
from line 3239
32173239
32183240 - `"webhooks-2026-10-07"`
32193241
3242 - `"admin-user-sign-out-2026-10-08"`
3243
32203244 - `"message-threads-2026-08-12"`
32213245
32223246 - `"analytics-usage-cost-2026-08-24"`
from line 3317
32933317
32943318 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
32953319
3320 - `"claude-fable-5-2"`
3321
3322 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3323
32963324 - `"claude-haiku-5-5"`
32973325
32983326 Fastest model for high-volume, real-time tasks
from line 4288
42604288
42614289 - `"webhooks-2026-10-07"`
42624290
4291 - `"admin-user-sign-out-2026-10-08"`
4292
42634293 - `"message-threads-2026-08-12"`
42644294
42654295 - `"analytics-usage-cost-2026-08-24"`
from line 4358
43284358
43294359 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
43304360
4331 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
4361 - `BetaManagedAgentsModel = "claude-fable-5-2" or "claude-haiku-5-5" or "claude-sonnet-5-5" or 15 more or string`
43324362
43334363 The model that will power your agent.
43344364
43354365 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
43364366
4367 - `"claude-fable-5-2"`
4368
4369 Built for the most ambitious work in coding, enterprise workflows, and the sciences
4370
43374371 - `"claude-haiku-5-5"`
43384372
43394373 Fastest model for high-volume, real-time tasks
from line 5324
52905324
52915325 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
52925326
5327 - `"claude-fable-5-2"`
5328
5329 Built for the most ambitious work in coding, enterprise workflows, and the sciences
5330
52935331 - `"claude-haiku-5-5"`
52945332
52955333 Fastest model for high-volume, real-time tasks
from line 6301
62636301
62646302 - `"webhooks-2026-10-07"`
62656303
6304 - `"admin-user-sign-out-2026-10-08"`
6305
62666306 - `"message-threads-2026-08-12"`
62676307
62686308 - `"analytics-usage-cost-2026-08-24"`
from line 6379
63396379
63406380 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
63416381
6382 - `"claude-fable-5-2"`
6383
6384 Built for the most ambitious work in coding, enterprise workflows, and the sciences
6385
63426386 - `"claude-haiku-5-5"`
63436387
63446388 Fastest model for high-volume, real-time tasks
from line 7299
72557299
72567300 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
72577301
7302 - `"claude-fable-5-2"`
7303
7304 Built for the most ambitious work in coding, enterprise workflows, and the sciences
7305
72587306 - `"claude-haiku-5-5"`
72597307
72607308 Fastest model for high-volume, real-time tasks
from line 8235
81878235
81888236 - `BetaManagedAgentsAutoPolicy object`
81898237
8190 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.
8191
8192 - `url_sources: BetaManagedAgentsWebFetchURLSources or null`
8193
8194 Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source.
8195
8196 - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null`
8197
8198 Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results.
8199
8200 - `BetaManagedAgentsWebFetchURLSourceAll object`
8201
8202 Every URL from this source may be fetched. This is the default.
8203
8204 - `type: "all"`
8205
8206 - `BetaManagedAgentsWebFetchURLSourceNone object`
8207
8208 This source contributes no URLs that may be fetched.
8209
8210 - `type: "none"`
8211
8212 - `BetaManagedAgentsWebFetchURLSourceOnly object`
8213
8214 Only the named tools' results contribute URLs that may be fetched.
8215
8216 - `type: "only"`
8217
8218 - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference`
8219
8220 The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results.
8221
8222 - `type: "tool_reference"`
8223
8224 Must be "tool_reference"
8238 The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow whe
api/beta/agents/archive Changed · +6 / -0 lines
from line 133
133133
134134 - `"webhooks-2026-10-07"`
135135
136 - `"admin-user-sign-out-2026-10-08"`
137
136138 - `"message-threads-2026-08-12"`
137139
138140 - `"analytics-usage-cost-2026-08-24"`
from line 210
208210 The model that will power your agent.
209211
210212 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
213
214 - `"claude-fable-5-2"`
215
216 Built for the most ambitious work in coding, enterprise workflows, and the sciences
211217
212218 - `"claude-haiku-5-5"`
213219
api/beta/agents/create Changed · +17 / -1 lines
from line 127
127127
128128 - `"webhooks-2026-10-07"`
129129
130 - `"admin-user-sign-out-2026-10-08"`
131
130132 - `"message-threads-2026-08-12"`
131133
132134 - `"analytics-usage-cost-2026-08-24"`
from line 147
145147
146148 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control
147149
148 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
150 - `BetaManagedAgentsModel = "claude-fable-5-2" or "claude-haiku-5-5" or "claude-sonnet-5-5" or 15 more or string`
149151
150152 The model that will power your agent.
151153
152154 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
153155
156 - `"claude-fable-5-2"`
157
158 Built for the most ambitious work in coding, enterprise workflows, and the sciences
159
154160 - `"claude-haiku-5-5"`
155161
156162 Fastest model for high-volume, real-time tasks
from line 1157
11511157
11521158 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
11531159
1160 - `"claude-fable-5-2"`
1161
1162 Built for the most ambitious work in coding, enterprise workflows, and the sciences
1163
11541164 - `"claude-haiku-5-5"`
11551165
11561166 Fastest model for high-volume, real-time tasks
from line 1901
18911901 "description": "A general-purpose starter agent.",
18921902 "metadata": {
18931903 "foo": "bar"
1904 },
1905 "multiagent": {
1906 "type": "multiagent_20261001",
1907 "workflows": {
1908 "type": "enabled"
1909 }
18941910 },
18951911 "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user'\''s task end to end.",
18961912 "tools": [
api/beta/agents/list Changed · +6 / -0 lines
from line 155
155155
156156 - `"webhooks-2026-10-07"`
157157
158 - `"admin-user-sign-out-2026-10-08"`
159
158160 - `"message-threads-2026-08-12"`
159161
160162 - `"analytics-usage-cost-2026-08-24"`
from line 232
230232 The model that will power your agent.
231233
232234 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
235
236 - `"claude-fable-5-2"`
237
238 Built for the most ambitious work in coding, enterprise workflows, and the sciences
233239
234240 - `"claude-haiku-5-5"`
235241
api/beta/agents/retrieve Changed · +6 / -0 lines
from line 141
141141
142142 - `"webhooks-2026-10-07"`
143143
144 - `"admin-user-sign-out-2026-10-08"`
145
144146 - `"message-threads-2026-08-12"`
145147
146148 - `"analytics-usage-cost-2026-08-24"`
from line 218
216218 The model that will power your agent.
217219
218220 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
221
222 - `"claude-fable-5-2"`
223
224 Built for the most ambitious work in coding, enterprise workflows, and the sciences
219225
220226 - `"claude-haiku-5-5"`
221227
api/beta/agents/update Changed · +11 / -1 lines
from line 133
133133
134134 - `"webhooks-2026-10-07"`
135135
136 - `"admin-user-sign-out-2026-10-08"`
137
136138 - `"message-threads-2026-08-12"`
137139
138140 - `"analytics-usage-cost-2026-08-24"`
from line 203
201203
202204 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
203205
204 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
206 - `BetaManagedAgentsModel = "claude-fable-5-2" or "claude-haiku-5-5" or "claude-sonnet-5-5" or 15 more or string`
205207
206208 The model that will power your agent.
207209
208210 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
209211
212 - `"claude-fable-5-2"`
213
214 Built for the most ambitious work in coding, enterprise workflows, and the sciences
215
210216 - `"claude-haiku-5-5"`
211217
212218 Fastest model for high-volume, real-time tasks
from line 1168
11621168 The model that will power your agent.
11631169
11641170 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
1171
1172 - `"claude-fable-5-2"`
1173
1174 Built for the most ambitious work in coding, enterprise workflows, and the sciences
11651175
11661176 - `"claude-haiku-5-5"`
11671177
api/beta/agents/versions Changed · +6 / -0 lines
from line 147
147147
148148 - `"webhooks-2026-10-07"`
149149
150 - `"admin-user-sign-out-2026-10-08"`
151
150152 - `"message-threads-2026-08-12"`
151153
152154 - `"analytics-usage-cost-2026-08-24"`
from line 224
222224 The model that will power your agent.
223225
224226 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
227
228 - `"claude-fable-5-2"`
229
230 Built for the most ambitious work in coding, enterprise workflows, and the sciences
225231
226232 - `"claude-haiku-5-5"`
227233
api/beta/agents/versions/list Changed · +6 / -0 lines
from line 145
145145
146146 - `"webhooks-2026-10-07"`
147147
148 - `"admin-user-sign-out-2026-10-08"`
149
148150 - `"message-threads-2026-08-12"`
149151
150152 - `"analytics-usage-cost-2026-08-24"`
from line 222
220222 The model that will power your agent.
221223
222224 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
225
226 - `"claude-fable-5-2"`
227
228 Built for the most ambitious work in coding, enterprise workflows, and the sciences
223229
224230 - `"claude-haiku-5-5"`
225231
api/beta/deployments Changed · +16 / -0 lines
from line 129
129129
130130 - `"webhooks-2026-10-07"`
131131
132 - `"admin-user-sign-out-2026-10-08"`
133
132134 - `"message-threads-2026-08-12"`
133135
134136 - `"analytics-usage-cost-2026-08-24"`
from line 1337
13351337
13361338 - `"webhooks-2026-10-07"`
13371339
1340 - `"admin-user-sign-out-2026-10-08"`
1341
13381342 - `"message-threads-2026-08-12"`
13391343
13401344 - `"analytics-usage-cost-2026-08-24"`
from line 2088
20842088
20852089 - `"webhooks-2026-10-07"`
20862090
2091 - `"admin-user-sign-out-2026-10-08"`
2092
20872093 - `"message-threads-2026-08-12"`
20882094
20892095 - `"analytics-usage-cost-2026-08-24"`
from line 2830
28242830
28252831 - `"webhooks-2026-10-07"`
28262832
2833 - `"admin-user-sign-out-2026-10-08"`
2834
28272835 - `"message-threads-2026-08-12"`
28282836
28292837 - `"analytics-usage-cost-2026-08-24"`
from line 3986
39783986
39793987 - `"webhooks-2026-10-07"`
39803988
3989 - `"admin-user-sign-out-2026-10-08"`
3990
39813991 - `"message-threads-2026-08-12"`
39823992
39833993 - `"analytics-usage-cost-2026-08-24"`
from line 4729
47194729
47204730 - `"webhooks-2026-10-07"`
47214731
4732 - `"admin-user-sign-out-2026-10-08"`
4733
47224734 - `"message-threads-2026-08-12"`
47234735
47244736 - `"analytics-usage-cost-2026-08-24"`
from line 5132
51205132
51215133 - `"webhooks-2026-10-07"`
51225134
5135 - `"admin-user-sign-out-2026-10-08"`
5136
51235137 - `"message-threads-2026-08-12"`
51245138
51255139 - `"analytics-usage-cost-2026-08-24"`
from line 5874
58605874 - `"telemetry-destinations-2026-08-11"`
58615875
58625876 - `"webhooks-2026-10-07"`
5877
5878 - `"admin-user-sign-out-2026-10-08"`
58635879
58645880 - `"message-threads-2026-08-12"`
58655881
api/beta/dreams Changed · +51 / -9 lines
from line 133
133133
134134 - `"webhooks-2026-10-07"`
135135
136 - `"admin-user-sign-out-2026-10-08"`
137
136138 - `"message-threads-2026-08-12"`
137139
138140 - `"analytics-usage-cost-2026-08-24"`
from line 257
255257
256258 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead.
257259
258 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
260 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to stable endpoints.
259261
260262 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
261263
from line 726
724726
725727 - `"webhooks-2026-10-07"`
726728
729 - `"admin-user-sign-out-2026-10-08"`
730
727731 - `"message-threads-2026-08-12"`
728732
729733 - `"analytics-usage-cost-2026-08-24"`
from line 1154
11501154
11511155 - `"webhooks-2026-10-07"`
11521156
1157 - `"admin-user-sign-out-2026-10-08"`
1158
11531159 - `"message-threads-2026-08-12"`
11541160
11551161 - `"analytics-usage-cost-2026-08-24"`
from line 1176
11701176
11711177 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead.
11721178
1173 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
1179 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to stable endpoints.
11741180
11751181 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
11761182
from line 1577
15711577
15721578 - `"webhooks-2026-10-07"`
15731579
1580 - `"admin-user-sign-out-2026-10-08"`
1581
15741582 - `"message-threads-2026-08-12"`
15751583
15761584 - `"analytics-usage-cost-2026-08-24"`
from line 1599
15911599
15921600 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead.
15931601
1594 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
1602 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to stable endpoints.
15951603
15961604 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
15971605
from line 2001
19932001
19942002 - `"webhooks-2026-10-07"`
19952003
2004 - `"admin-user-sign-out-2026-10-08"`
2005
19962006 - `"message-threads-2026-08-12"`
19972007
19982008 - `"analytics-usage-cost-2026-08-24"`
from line 2023
20132023
20142024 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead.
20152025
2016 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
2026 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to stable endpoints.
20172027
20182028 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
20192029
from line 2301
22912301
22922302 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead.
22932303
2294 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
2304 The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to stable endpoints.
22952305
22962306 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces.
22972307
from line 2753
27432753
27442754 - `type: "invalid_request_error"`
27452755
2756 The broad category of the error.
2757
27462758 default: invalid_request_error
27472759
27482760 - `message: string`
27492761
2762 A human-readable explanation of the error. Its wording can change, so don't match on it.
2763
27502764 default: Invalid request
27512765
27522766 - `BetaAuthenticationError object`
from line 2767
27532767
27542768 - `type: "authentication_error"`
27552769
2770 The broad category of the error.
2771
27562772 default: authentication_error
27572773
27582774 - `message: string`
27592775
2776 A human-readable explanation of the error. Its wording can change, so don't match on it.
2777
27602778 default: Authentication error
27612779
27622780 - `BetaBillingError object`
from line 2781
27632781
27642782 - `type: "billing_error"`
27652783
2784 The broad category of the error.
2785
27662786 default: billing_error
27672787
27682788 - `message: string`
27692789
2790 A human-readable explanation of the error. Its wording can change, so don't match on it.
2791
27702792 default: Billing error
27712793
27722794 - `BetaPermissionError object`
from line 2795
27732795
27742796 - `type: "permission_error"`
27752797
2798 The broad category of the error.
2799
27762800 default: permission_error
27772801
27782802 - `message: string`
27792803
2804 A human-readable explanation of the error. Its wording can change, so don't match on it.
2805
27802806 default: Permission denied
27812807
27822808 - `BetaNotFoundError object`
from line 2809
27832809
27842810 - `type: "not_found_error"`
27852811
2812 The broad category of the error.
2813
27862814 default: not_found_error
27872815
27882816 - `message: string`
27892817
2818 A human-readable explanation of the error. Its wording can change, so don't match on it.
2819
27902820 default: Not found
27912821
27922822 - `BetaRateLimitError object`
from line 2823
27932823
27942824 - `type: "rate_limit_error"`
27952825
2826 The broad category of the error.
2827
27962828 default: rate_limit_error
27972829
27982830 - `message: string`
27992831
2832 A human-readable explanation of the error. Its wording can change, so don't match on it.
2833
28002834 default: Rate limited
28012835
28022836 - `BetaGatewayTimeoutError object`
from line 2837
28032837
28042838 - `type: "timeout_error"`
28052839
2840 The broad category of the error.
2841
28062842 default: timeout_error
28072843
28082844 - `message: string`
28092845
2846 A human-readable explanation of the error. Its wording can change, so don't match on it.
2847
28102848 default: Request timeout
28112849
28122850 - `BetaAPIError object`
from line 2851
28132851
28142852 - `type: "api_error"`
28152853
2854 The broad category of the error.
2855
28162856 default: api_error
28172857
28182858 - `message: string`
28192859
2860 A human-readable explanation of the error. Its wording can change, so don't match on it.
2861
28202862 default: Internal server error
28212863
28222864 - `BetaOverloadedError object`
from line 2865
28232865
28242866 - `type: "overloaded_error"`
28252867
2868 The broad category of the error.
2869
28262870 default: overloaded_error
28272871
28282872 - `message: string`
28292873
2874 A human-readable explanation of the error. Its wording can change, so don't match on it.
2875
28302876 default: Overloaded
28312877
28322878 - `BetaTargetStoreHeldError object`
from line 2885
28392885
28402886 - `message: optional string`
28412887
2842 A human-readable explanation of why the memory store can't be used yet, with the ID of the dream that is using it when the server can identify it.
2843
28442888### Beta Output Behavior
28452889
28462890- `BetaOutputBehavior = BetaOutputBehaviorCreateNew or BetaOutputBehaviorUpdateExisting`
from line 2950
29062950 - `type: "conflict_error"`
29072951
29082952 - `message: optional string`
2909
2910 A human-readable explanation of why the memory store can't be used yet, with the ID of the dream that is using it when the server can identify it.
29112953
api/beta/environments Changed · +77 / -1 lines
### Beta Environment Archived Error Details ### Beta Environment Create Disabled Error Details ### Beta Environment Not Found Error Details ### Beta Environment Update Disabled Error Details ### Beta Invalid Config Type Change Error Details ### Beta Invalid Metadata Error Details
from line 129
129129
130130 - `"webhooks-2026-10-07"`
131131
132 - `"admin-user-sign-out-2026-10-08"`
133
132134 - `"message-threads-2026-08-12"`
133135
134136 - `"analytics-usage-cost-2026-08-24"`
from line 616
614616
615617 - `"webhooks-2026-10-07"`
616618
619 - `"admin-user-sign-out-2026-10-08"`
620
617621 - `"message-threads-2026-08-12"`
618622
619623 - `"analytics-usage-cost-2026-08-24"`
from line 959
955959
956960 - `"webhooks-2026-10-07"`
957961
962 - `"admin-user-sign-out-2026-10-08"`
963
958964 - `"message-threads-2026-08-12"`
959965
960966 - `"analytics-usage-cost-2026-08-24"`
from line 1293
12871293
12881294 - `"webhooks-2026-10-07"`
12891295
1296 - `"admin-user-sign-out-2026-10-08"`
1297
12901298 - `"message-threads-2026-08-12"`
12911299
12921300 - `"analytics-usage-cost-2026-08-24"`
from line 1749
17411749
17421750 - `"webhooks-2026-10-07"`
17431751
1752 - `"admin-user-sign-out-2026-10-08"`
1753
17441754 - `"message-threads-2026-08-12"`
17451755
17461756 - `"analytics-usage-cost-2026-08-24"`
from line 1926
19161926
19171927 - `"webhooks-2026-10-07"`
19181928
1929 - `"admin-user-sign-out-2026-10-08"`
1930
19191931 - `"message-threads-2026-08-12"`
19201932
19211933 - `"analytics-usage-cost-2026-08-24"`
from line 2427
24152427
24162428 - `"account"`
24172429
2430### Beta Environment Archived Error Details
2431
2432- `BetaEnvironmentArchivedErrorDetails object`
2433
2434 The environment is archived, so it cannot be updated.
2435
2436 - `error_code: "environment_archived"`
2437
2438### Beta Environment Create Disabled Error Details
2439
2440- `BetaEnvironmentCreateDisabledErrorDetails object`
2441
2442 Anthropic has turned off creating environments for this organization. Existing environments still work.
2443
2444 - `error_code: "environment_create_disabled"`
2445
24182446### Beta Environment Delete Response
24192447
24202448- `BetaEnvironmentDeleteResponse object`
from line 2459
24312459
24322460 Environment identifier
24332461
2462### Beta Environment Not Found Error Details
2463
2464- `BetaEnvironmentNotFoundErrorDetails object`
2465
2466 `settings.environment_id` names no Environment within the organization's reach.
2467
2468 - `error_code: "environment_not_found"`
2469
2470### Beta Environment Update Disabled Error Details
2471
2472- `BetaEnvironmentUpdateDisabledErrorDetails object`
2473
2474 Anthropic has turned off updating environments for this organization. Existing environments still work as they are.
2475
2476 - `error_code: "environment_update_disabled"`
2477
2478### Beta Invalid Config Type Change Error Details
2479
2480- `BetaInvalidConfigTypeChangeErrorDetails object`
2481
2482 `config.type` differs from the environment's stored type, which cannot change after creation.
2483
2484 - `error_code: "invalid_config_type_change"`
2485
2486### Beta Invalid Metadata Error Details
2487
2488- `BetaInvalidMetadataErrorDetails object`
2489
2490 `metadata` has too many keys, a key or value that is too long, or a reserved key. The message names each problem.
2491
2492 - `error_code: "invalid_metadata"`
2493
24342494### Beta Limited Network
24352495
24362496- `BetaLimitedNetwork object`
from line 2778
27182778
27192779 - `"webhooks-2026-10-07"`
27202780
2781 - `"admin-user-sign-out-2026-10-08"`
2782
27212783 - `"message-threads-2026-08-12"`
27222784
27232785 - `"analytics-usage-cost-2026-08-24"`
from line 3052
29903052
29913053 - `"webhooks-2026-10-07"`
29923054
3055 - `"admin-user-sign-out-2026-10-08"`
3056
29933057 - `"message-threads-2026-08-12"`
29943058
29953059 - `"analytics-usage-cost-2026-08-24"`
from line 3312
32483312
32493313 - `"webhooks-2026-10-07"`
32503314
3315 - `"admin-user-sign-out-2026-10-08"`
3316
32513317 - `"message-threads-2026-08-12"`
32523318
32533319 - `"analytics-usage-cost-2026-08-24"`
from line 3459
33933459
33943460- `expected_last_heartbeat: optional string`
33953461
3396 Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match.
3462 Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match. The server does not compare the value when the work item is 'stopping' or 'stopped'.
33973463
33983464#### Headers
33993465
from line 3579
35133579
35143580 - `"webhooks-2026-10-07"`
35153581
3582 - `"admin-user-sign-out-2026-10-08"`
3583
35163584 - `"message-threads-2026-08-12"`
35173585
35183586 - `"analytics-usage-cost-2026-08-24"`
from line 3779
37113779
37123780 - `"webhooks-2026-10-07"`
37133781
3782 - `"admin-user-sign-out-2026-10-08"`
3783
37143784 - `"message-threads-2026-08-12"`
37153785
37163786 - `"analytics-usage-cost-2026-08-24"`
from line 4061
39914061
39924062 - `"webhooks-2026-10-07"`
39934063
4064 - `"admin-user-sign-out-2026-10-08"`
4065
39944066 - `"message-threads-2026-08-12"`
39954067
39964068 - `"analytics-usage-cost-2026-08-24"`
from line 4326
42544326
42554327 - `"webhooks-2026-10-07"`
42564328
4329 - `"admin-user-sign-out-2026-10-08"`
4330
42574331 - `"message-threads-2026-08-12"`
42584332
42594333 - `"analytics-usage-cost-2026-08-24"`
from line 4595
45214595 - `"telemetry-destinations-2026-08-11"`
45224596
45234597 - `"webhooks-2026-10-07"`
4598
4599 - `"admin-user-sign-out-2026-10-08"`
45244600
45254601 - `"message-threads-2026-08-12"`
45264602
api/beta/environments/work Changed · +87 / -1 lines
### Beta Heartbeat Precondition Failed Error Details ### Beta Work Lease State
from line 137
137137
138138 - `"webhooks-2026-10-07"`
139139
140 - `"admin-user-sign-out-2026-10-08"`
141
140142 - `"message-threads-2026-08-12"`
141143
142144 - `"analytics-usage-cost-2026-08-24"`
from line 411
409411
410412 - `"webhooks-2026-10-07"`
411413
414 - `"admin-user-sign-out-2026-10-08"`
415
412416 - `"message-threads-2026-08-12"`
413417
414418 - `"analytics-usage-cost-2026-08-24"`
from line 671
667671
668672 - `"webhooks-2026-10-07"`
669673
674 - `"admin-user-sign-out-2026-10-08"`
675
670676 - `"message-threads-2026-08-12"`
671677
672678 - `"analytics-usage-cost-2026-08-24"`
from line 818
812818
813819- `expected_last_heartbeat: optional string`
814820
815 Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match.
821 Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match. The server does not compare the value when the work item is 'stopping' or 'stopped'.
816822
817823### Headers
818824
from line 938
932938
933939 - `"webhooks-2026-10-07"`
934940
941 - `"admin-user-sign-out-2026-10-08"`
942
935943 - `"message-threads-2026-08-12"`
936944
937945 - `"analytics-usage-cost-2026-08-24"`
from line 1138
11301138
11311139 - `"webhooks-2026-10-07"`
11321140
1141 - `"admin-user-sign-out-2026-10-08"`
1142
11331143 - `"message-threads-2026-08-12"`
11341144
11351145 - `"analytics-usage-cost-2026-08-24"`
from line 1420
14101420
14111421 - `"webhooks-2026-10-07"`
14121422
1423 - `"admin-user-sign-out-2026-10-08"`
1424
14131425 - `"message-threads-2026-08-12"`
14141426
14151427 - `"analytics-usage-cost-2026-08-24"`
from line 1685
16731685
16741686 - `"webhooks-2026-10-07"`
16751687
1688 - `"admin-user-sign-out-2026-10-08"`
1689
16761690 - `"message-threads-2026-08-12"`
16771691
16781692 - `"analytics-usage-cost-2026-08-24"`
from line 1955
19411955
19421956 - `"webhooks-2026-10-07"`
19431957
1958 - `"admin-user-sign-out-2026-10-08"`
1959
19441960 - `"message-threads-2026-08-12"`
19451961
19461962 - `"analytics-usage-cost-2026-08-24"`
from line 2022
20062022
20072023## Domain types
20082024
2025### Beta Heartbeat Precondition Failed Error Details
2026
2027- `BetaHeartbeatPreconditionFailedErrorDetails object`
2028
2029 `expected_last_heartbeat` does not match the stored heartbeat, so another worker may hold the lease.
2030
2031 - `current_state: BetaWorkLeaseState`
2032
2033 The lease as the server holds it.
2034
2035 - `last_heartbeat: string or null`
2036
2037 RFC 3339 timestamp of the stored heartbeat, or null if there has been none
2038
2039 - `lease_extended: boolean`
2040
2041 Always false: a refused heartbeat does not extend the lease
2042
2043 - `state: "queued" or "starting" or "active" or 2 more`
2044
2045 Current state of the work item
2046
2047 - `"queued"`
2048
2049 - `"starting"`
2050
2051 - `"active"`
2052
2053 - `"stopping"`
2054
2055 - `"stopped"`
2056
2057 - `ttl_seconds: number`
2058
2059 TTL of the lease
2060
2061 - `error_code: "heartbeat_precondition_failed"`
2062
20092063### Beta Self Hosted Work
20102064
20112065- `BetaSelfHostedWork object`
from line 2334
22802334 - `id: string`
22812335
22822336 Session identifier (e.g., 'session_...')
2337
2338### Beta Work Lease State
2339
2340- `BetaWorkLeaseState object`
2341
2342 A work item's lease as the server holds it.
2343
2344 - `last_heartbeat: string or null`
2345
2346 RFC 3339 timestamp of the stored heartbeat, or null if there has been none
2347
2348 - `lease_extended: boolean`
2349
2350 Always false: a refused heartbeat does not extend the lease
2351
2352 - `state: "queued" or "starting" or "active" or 2 more`
2353
2354 Current state of the work item
2355
2356 - `"queued"`
2357
2358 - `"starting"`
2359
2360 - `"active"`
2361
2362 - `"stopping"`
2363
2364 - `"stopped"`
2365
2366 - `ttl_seconds: number`
2367
2368 TTL of the lease
22832369
api/beta/files Changed · +10 / -0 lines
from line 129
129129
130130 - `"webhooks-2026-10-07"`
131131
132 - `"admin-user-sign-out-2026-10-08"`
133
132134 - `"message-threads-2026-08-12"`
133135
134136 - `"analytics-usage-cost-2026-08-24"`
from line 396
394396
395397 - `"webhooks-2026-10-07"`
396398
399 - `"admin-user-sign-out-2026-10-08"`
400
397401 - `"message-threads-2026-08-12"`
398402
399403 - `"analytics-usage-cost-2026-08-24"`
from line 642
638642
639643 - `"webhooks-2026-10-07"`
640644
645 - `"admin-user-sign-out-2026-10-08"`
646
641647 - `"message-threads-2026-08-12"`
642648
643649 - `"analytics-usage-cost-2026-08-24"`
from line 794
788794
789795 - `"webhooks-2026-10-07"`
790796
797 - `"admin-user-sign-out-2026-10-08"`
798
791799 - `"message-threads-2026-08-12"`
792800
793801 - `"analytics-usage-cost-2026-08-24"`
from line 1028
10201028 - `"telemetry-destinations-2026-08-11"`
10211029
10221030 - `"webhooks-2026-10-07"`
1031
1032 - `"admin-user-sign-out-2026-10-08"`
10231033
10241034 - `"message-threads-2026-08-12"`
10251035
api/beta/memory_stores Changed · +28 / -0 lines
from line 129
129129
130130 - `"webhooks-2026-10-07"`
131131
132 - `"admin-user-sign-out-2026-10-08"`
133
132134 - `"message-threads-2026-08-12"`
133135
134136 - `"analytics-usage-cost-2026-08-24"`
from line 399
397399
398400 - `"webhooks-2026-10-07"`
399401
402 - `"admin-user-sign-out-2026-10-08"`
403
400404 - `"message-threads-2026-08-12"`
401405
402406 - `"analytics-usage-cost-2026-08-24"`
from line 626
622626
623627 - `"webhooks-2026-10-07"`
624628
629 - `"admin-user-sign-out-2026-10-08"`
630
625631 - `"message-threads-2026-08-12"`
626632
627633 - `"analytics-usage-cost-2026-08-24"`
from line 848
842848
843849 - `"webhooks-2026-10-07"`
844850
851 - `"admin-user-sign-out-2026-10-08"`
852
845853 - `"message-threads-2026-08-12"`
846854
847855 - `"analytics-usage-cost-2026-08-24"`
from line 1094
10861094
10871095 - `"webhooks-2026-10-07"`
10881096
1097 - `"admin-user-sign-out-2026-10-08"`
1098
10891099 - `"message-threads-2026-08-12"`
10901100
10911101 - `"analytics-usage-cost-2026-08-24"`
from line 1271
12611271
12621272 - `"webhooks-2026-10-07"`
12631273
1274 - `"admin-user-sign-out-2026-10-08"`
1275
12641276 - `"message-threads-2026-08-12"`
12651277
12661278 - `"analytics-usage-cost-2026-08-24"`
from line 1574
15621574
15631575 - `"webhooks-2026-10-07"`
15641576
1577 - `"admin-user-sign-out-2026-10-08"`
1578
15651579 - `"message-threads-2026-08-12"`
15661580
15671581 - `"analytics-usage-cost-2026-08-24"`
from line 1871
18571871
18581872 - `"webhooks-2026-10-07"`
18591873
1874 - `"admin-user-sign-out-2026-10-08"`
1875
18601876 - `"message-threads-2026-08-12"`
18611877
18621878 - `"analytics-usage-cost-2026-08-24"`
from line 2150
21342150
21352151 - `"webhooks-2026-10-07"`
21362152
2153 - `"admin-user-sign-out-2026-10-08"`
2154
21372155 - `"message-threads-2026-08-12"`
21382156
21392157 - `"analytics-usage-cost-2026-08-24"`
from line 2404
23862404
23872405 - `"webhooks-2026-10-07"`
23882406
2407 - `"admin-user-sign-out-2026-10-08"`
2408
23892409 - `"message-threads-2026-08-12"`
23902410
23912411 - `"analytics-usage-cost-2026-08-24"`
from line 2680
26602680
26612681 - `"webhooks-2026-10-07"`
26622682
2683 - `"admin-user-sign-out-2026-10-08"`
2684
26632685 - `"message-threads-2026-08-12"`
26642686
26652687 - `"analytics-usage-cost-2026-08-24"`
from line 2935
29132935
29142936 - `"webhooks-2026-10-07"`
29152937
2938 - `"admin-user-sign-out-2026-10-08"`
2939
29162940 - `"message-threads-2026-08-12"`
29172941
29182942 - `"analytics-usage-cost-2026-08-24"`
from line 3275
32513275
32523276 - `"webhooks-2026-10-07"`
32533277
3278 - `"admin-user-sign-out-2026-10-08"`
3279
32543280 - `"message-threads-2026-08-12"`
32553281
32563282 - `"analytics-usage-cost-2026-08-24"`
from line 3595
35693595 - `"telemetry-destinations-2026-08-11"`
35703596
35713597 - `"webhooks-2026-10-07"`
3598
3599 - `"admin-user-sign-out-2026-10-08"`
35723600
35733601 - `"message-threads-2026-08-12"`
35743602
api/beta/memory_stores/memories Changed · +50 / -8 lines
from line 151
151151
152152 - `"webhooks-2026-10-07"`
153153
154 - `"admin-user-sign-out-2026-10-08"`
155
154156 - `"message-threads-2026-08-12"`
155157
156158 - `"analytics-usage-cost-2026-08-24"`
from line 448
446448
447449 - `"webhooks-2026-10-07"`
448450
451 - `"admin-user-sign-out-2026-10-08"`
452
449453 - `"message-threads-2026-08-12"`
450454
451455 - `"analytics-usage-cost-2026-08-24"`
from line 727
723727
724728 - `"webhooks-2026-10-07"`
725729
730 - `"admin-user-sign-out-2026-10-08"`
731
726732 - `"message-threads-2026-08-12"`
727733
728734 - `"analytics-usage-cost-2026-08-24"`
from line 981
975981
976982 - `"webhooks-2026-10-07"`
977983
984 - `"admin-user-sign-out-2026-10-08"`
985
978986 - `"message-threads-2026-08-12"`
979987
980988 - `"analytics-usage-cost-2026-08-24"`
from line 1257
12491257
12501258 - `"webhooks-2026-10-07"`
12511259
1260 - `"admin-user-sign-out-2026-10-08"`
1261
12521262 - `"message-threads-2026-08-12"`
12531263
12541264 - `"analytics-usage-cost-2026-08-24"`
from line 1356
13461356
13471357 - `type: "invalid_request_error"`
13481358
1359 The broad category of the error.
1360
13491361 default: invalid_request_error
13501362
13511363 - `message: string`
13521364
1365 A human-readable explanation of the error. Its wording can change, so don't match on it.
1366
13531367 default: Invalid request
13541368
13551369 - `BetaAuthenticationError object`
from line 1370
13561370
13571371 - `type: "authentication_error"`
13581372
1373 The broad category of the error.
1374
13591375 default: authentication_error
13601376
13611377 - `message: string`
13621378
1379 A human-readable explanation of the error. Its wording can change, so don't match on it.
1380
13631381 default: Authentication error
13641382
13651383 - `BetaBillingError object`
from line 1384
13661384
13671385 - `type: "billing_error"`
13681386
1387 The broad category of the error.
1388
13691389 default: billing_error
13701390
13711391 - `message: string`
13721392
1393 A human-readable explanation of the error. Its wording can change, so don't match on it.
1394
13731395 default: Billing error
13741396
13751397 - `BetaPermissionError object`
from line 1398
13761398
13771399 - `type: "permission_error"`
13781400
1401 The broad category of the error.
1402
13791403 default: permission_error
13801404
13811405 - `message: string`
13821406
1407 A human-readable explanation of the error. Its wording can change, so don't match on it.
1408
13831409 default: Permission denied
13841410
13851411 - `BetaNotFoundError object`
from line 1412
13861412
13871413 - `type: "not_found_error"`
13881414
1415 The broad category of the error.
1416
13891417 default: not_found_error
13901418
13911419 - `message: string`
13921420
1421 A human-readable explanation of the error. Its wording can change, so don't match on it.
1422
13931423 default: Not found
13941424
13951425 - `BetaRateLimitError object`
from line 1426
13961426
13971427 - `type: "rate_limit_error"`
13981428
1429 The broad category of the error.
1430
13991431 default: rate_limit_error
14001432
14011433 - `message: string`
14021434
1435 A human-readable explanation of the error. Its wording can change, so don't match on it.
1436
14031437 default: Rate limited
14041438
14051439 - `BetaGatewayTimeoutError object`
from line 1440
14061440
14071441 - `type: "timeout_error"`
14081442
1443 The broad category of the error.
1444
14091445 default: timeout_error
14101446
14111447 - `message: string`
14121448
1449 A human-readable explanation of the error. Its wording can change, so don't match on it.
1450
14131451 default: Request timeout
14141452
14151453 - `BetaAPIError object`
from line 1454
14161454
14171455 - `type: "api_error"`
14181456
1457 The broad category of the error.
1458
14191459 default: api_error
14201460
14211461 - `message: string`
14221462
1463 A human-readable explanation of the error. Its wording can change, so don't match on it.
1464
14231465 default: Internal server error
14241466
14251467 - `BetaOverloadedError object`
from line 1468
14261468
14271469 - `type: "overloaded_error"`
14281470
1471 The broad category of the error.
1472
14291473 default: overloaded_error
14301474
14311475 - `message: string`
14321476
1477 A human-readable explanation of the error. Its wording can change, so don't match on it.
1478
14331479 default: Overloaded
14341480
14351481 - `BetaManagedAgentsMemoryPreconditionFailedError object`
from line 1490
14441490
14451491 - `message: optional string`
14461492
1447 A human-readable explanation of why the precondition failed.
1448
14491493 - `BetaManagedAgentsMemoryPathConflictError object`
14501494
14511495 The error returned with HTTP status 409 when you create or rename a memory and the path you give is already used by another memory or overlaps another memory's path.
from line 1496
14521496
14531497 Two paths overlap when one is an ancestor of the other, such as `/notes` and `/notes/todo.md`. To free the path, rename or delete the memory that `conflicting_memory_id` references, then retry. To change that memory instead of creating a new one, update it.
14541498
1499 To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead of `message`.
1500
14551501 - `type: "memory_path_conflict_error"`
14561502
14571503 - `conflicting_memory_id: optional string`
from line 1512
14661512
14671513 - `message: optional string`
14681514
1469 A human-readable explanation of the conflict. To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead.
1470
14711515 - `BetaManagedAgentsConflictError object`
14721516
14731517 - `type: "conflict_error"`
from line 1670
16261670
16271671 Two paths overlap when one is an ancestor of the other, such as `/notes` and `/notes/todo.md`. To free the path, rename or delete the memory that `conflicting_memory_id` references, then retry. To change that memory instead of creating a new one, update it.
16281672
1673 To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead of `message`.
1674
16291675 - `type: "memory_path_conflict_error"`
16301676
16311677 - `conflicting_memory_id: optional string`
from line 1686
16401686
16411687 - `message: optional string`
16421688
1643 A human-readable explanation of the conflict. To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead.
1644
16451689### Beta Managed Agents Memory Precondition Failed Error
16461690
16471691- `BetaManagedAgentsMemoryPreconditionFailedError object`
from line 1699
16551699 - `type: "memory_precondition_failed_error"`
16561700
16571701 - `message: optional string`
1658
1659 A human-readable explanation of why the precondition failed.
16601702
16611703### Beta Managed Agents Memory Prefix
16621704
api/beta/memory_stores/memory_versions Changed · +6 / -0 lines
from line 209
209209
210210 - `"webhooks-2026-10-07"`
211211
212 - `"admin-user-sign-out-2026-10-08"`
213
212214 - `"message-threads-2026-08-12"`
213215
214216 - `"analytics-usage-cost-2026-08-24"`
from line 549
547549
548550 - `"webhooks-2026-10-07"`
549551
552 - `"admin-user-sign-out-2026-10-08"`
553
550554 - `"message-threads-2026-08-12"`
551555
552556 - `"analytics-usage-cost-2026-08-24"`
from line 869
865869 - `"telemetry-destinations-2026-08-11"`
866870
867871 - `"webhooks-2026-10-07"`
872
873 - `"admin-user-sign-out-2026-10-08"`
868874
869875 - `"message-threads-2026-08-12"`
870876
api/beta/messages Changed · +429 / -19 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 133
133133
134134 - `"webhooks-2026-10-07"`
135135
136 - `"admin-user-sign-out-2026-10-08"`
137
136138 - `"message-threads-2026-08-12"`
137139
138140 - `"analytics-usage-cost-2026-08-24"`
from line 3130
31283130
31293131 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31303132
3133 - `"claude-fable-5-2"`
3134
3135 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3136
3137 - `"claude-mythos-5-2"`
3138
3139 Built for the most demanding cybersecurity and life sciences research, available through verification programs
3140
31313141 - `"claude-haiku-5-5"`
31323142
31333143 Fastest model for high-volume, real-time tasks
from line 3488
34783488 Accepted in `messages[].content` and not rendered into the prompt; not
34793489 validated against the request's `fallbacks` chain or top-level `model`.
34803490
3481 Echo the assistant turn back verbatim, including this block in its
3491 When you send the assistant turn back, keep this block in its
34823492 original position. The block marks the boundary between content produced
34833493 before and after a fallback hop, and the server relies on that boundary
34843494 to validate the turn: when thinking runs flank the boundary, omitting
from line 3495
34853495 the block merges them into one span the server cannot validate (the
34863496 request is rejected), and moving it into the middle of a single run is
34873497 likewise rejected; between non-thinking blocks the block's placement has
3488 no validation effect.
3498 no effect on thinking validation.
34893499
3500 Some blocks from before the turn's final `fallback` block must be left
3501 out when you send the turn back, and no `tool_result` is sent for a
3502 `tool_use` block you left out.
3503
3504 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
3505
34903506 - `type: "fallback"`
34913507
34923508 - `from: BetaFallbackInfoParam`
from line 7018
70027018
70037019 Citations configuration for fetched documents. Citations are disabled by default.
70047020
7005 - `defer_loading: optional boolean`
7006
7007 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7008
7009 - `max_content_tokens: optional number or null`
7010
7011 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.
7012
7013 minimum: 1
7014
7015 - `max_uses: optional number or null`
7016
7017 Maximum number of times the tool can be used in the API request.
7018
7019 minimum: 1
7020
7021 - `response_inclusion: optional "full" or "excluded"`
7022
7023 How this tool's result blocks appear in the API resp
api/beta/messages/batches Changed · +204 / -2 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 133
133133
134134 - `"webhooks-2026-10-07"`
135135
136 - `"admin-user-sign-out-2026-10-08"`
137
136138 - `"message-threads-2026-08-12"`
137139
138140 - `"analytics-usage-cost-2026-08-24"`
from line 3150
31483150
31493151 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31503152
3153 - `"claude-fable-5-2"`
3154
3155 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3156
3157 - `"claude-mythos-5-2"`
3158
3159 Built for the most demanding cybersecurity and life sciences research, available through verification programs
3160
31513161 - `"claude-haiku-5-5"`
31523162
31533163 Fastest model for high-volume, real-time tasks
from line 3508
34983508 Accepted in `messages[].content` and not rendered into the prompt; not
34993509 validated against the request's `fallbacks` chain or top-level `model`.
35003510
3501 Echo the assistant turn back verbatim, including this block in its
3511 When you send the assistant turn back, keep this block in its
35023512 original position. The block marks the boundary between content produced
35033513 before and after a fallback hop, and the server relies on that boundary
35043514 to validate the turn: when thinking runs flank the boundary, omitting
from line 3515
35053515 the block merges them into one span the server cannot validate (the
35063516 request is rejected), and moving it into the middle of a single run is
35073517 likewise rejected; between non-thinking blocks the block's placement has
3508 no validation effect.
3518 no effect on thinking validation.
35093519
3520 Some blocks from before the turn's final `fallback` block must be left
3521 out when you send the turn back, and no `tool_result` is sent for a
3522 `tool_use` block you left out.
3523
3524 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
3525
35103526 - `type: "fallback"`
35113527
35123528 - `from: BetaFallbackInfoParam`
from line 4635
46194635
46204636 - `"webhooks-2026-10-07"`
46214637
4638 - `"admin-user-sign-out-2026-10-08"`
4639
46224640 - `"message-threads-2026-08-12"`
46234641
46244642 - `"analytics-usage-cost-2026-08-24"`
from line 4935
49174935
49184936 - `"webhooks-2026-10-07"`
49194937
4938 - `"admin-user-sign-out-2026-10-08"`
4939
49204940 - `"message-threads-2026-08-12"`
49214941
49224942 - `"analytics-usage-cost-2026-08-24"`
from line 5244
52245244
52255245 - `"webhooks-2026-10-07"`
52265246
5247 - `"admin-user-sign-out-2026-10-08"`
5248
52275249 - `"message-threads-2026-08-12"`
52285250
52295251 - `"analytics-usage-cost-2026-08-24"`
from line 5535
55135535
55145536 - `"webhooks-2026-10-07"`
55155537
5538 - `"admin-user-sign-out-2026-10-08"`
5539
55165540 - `"message-threads-2026-08-12"`
55175541
55185542 - `"analytics-usage-cost-2026-08-24"`
from line 5718
56945718
56955719 - `"webhooks-2026-10-07"`
56965720
5721 - `"admin-user-sign-out-2026-10-08"`
5722
56975723 - `"message-threads-2026-08-12"`
56985724
56995725 - `"analytics-usage-cost-2026-08-24"`
from line 7240
72147240
72157241 - `enabled: optional boolean or null`
72167242
7217 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
7218
7219 - `navigate: optional BetaBrowserNavigateConfig or null`
7220
7221 `navigate`'s config overrides.
7222
7223 - `defer_loading: optional boolean or null`
7224
7225 Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
7226
7227 - `enabled: optional boolean or null`
7228
7229 Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.
7230
7231 - `new_tab: optional BetaBrowserNewTabConfig or null`
7232
7233 `new_tab`'s config overrides.
7234
7235 - `defer_loading: optional boolean
7243
api/beta/messages/batches/create Changed · +18 / -2 lines
from line 131
131131
132132 - `"webhooks-2026-10-07"`
133133
134 - `"admin-user-sign-out-2026-10-08"`
135
134136 - `"message-threads-2026-08-12"`
135137
136138 - `"analytics-usage-cost-2026-08-24"`
from line 3148
31463148
31473149 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31483150
3151 - `"claude-fable-5-2"`
3152
3153 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3154
3155 - `"claude-mythos-5-2"`
3156
3157 Built for the most demanding cybersecurity and life sciences research, available through verification programs
3158
31493159 - `"claude-haiku-5-5"`
31503160
31513161 Fastest model for high-volume, real-time tasks
from line 3506
34963506 Accepted in `messages[].content` and not rendered into the prompt; not
34973507 validated against the request's `fallbacks` chain or top-level `model`.
34983508
3499 Echo the assistant turn back verbatim, including this block in its
3509 When you send the assistant turn back, keep this block in its
35003510 original position. The block marks the boundary between content produced
35013511 before and after a fallback hop, and the server relies on that boundary
35023512 to validate the turn: when thinking runs flank the boundary, omitting
from line 3513
35033513 the block merges them into one span the server cannot validate (the
35043514 request is rejected), and moving it into the middle of a single run is
35053515 likewise rejected; between non-thinking blocks the block's placement has
3506 no validation effect.
3516 no effect on thinking validation.
3517
3518 Some blocks from before the turn's final `fallback` block must be left
3519 out when you send the turn back, and no `tool_result` is sent for a
3520 `tool_use` block you left out.
3521
3522 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
35073523
35083524 - `type: "fallback"`
35093525
api/beta/messages/batches/results Changed · +46 / -0 lines
from line 137
137137
138138 - `"webhooks-2026-10-07"`
139139
140 - `"admin-user-sign-out-2026-10-08"`
141
140142 - `"message-threads-2026-08-12"`
141143
142144 - `"analytics-usage-cost-2026-08-24"`
from line 2914
29122914
29132915 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
29142916
2917 - `"claude-fable-5-2"`
2918
2919 Built for the most ambitious work in coding, enterprise workflows, and the sciences
2920
2921 - `"claude-mythos-5-2"`
2922
2923 Built for the most demanding cybersecurity and life sciences research, available through verification programs
2924
29152925 - `"claude-haiku-5-5"`
29162926
29172927 Fastest model for high-volume, real-time tasks
from line 4063
40534063
40544064 - `type: "invalid_request_error"`
40554065
4066 The broad category of the error.
4067
40564068 default: invalid_request_error
40574069
40584070 - `message: string`
40594071
4072 A human-readable explanation of the error. Its wording can change, so don't match on it.
4073
40604074 default: Invalid request
40614075
40624076 - `BetaAuthenticationError object`
from line 4077
40634077
40644078 - `type: "authentication_error"`
40654079
4080 The broad category of the error.
4081
40664082 default: authentication_error
40674083
40684084 - `message: string`
40694085
4086 A human-readable explanation of the error. Its wording can change, so don't match on it.
4087
40704088 default: Authentication error
40714089
40724090 - `BetaBillingError object`
from line 4091
40734091
40744092 - `type: "billing_error"`
40754093
4094 The broad category of the error.
4095
40764096 default: billing_error
40774097
40784098 - `message: string`
40794099
4100 A human-readable explanation of the error. Its wording can change, so don't match on it.
4101
40804102 default: Billing error
40814103
40824104 - `BetaPermissionError object`
from line 4105
40834105
40844106 - `type: "permission_error"`
40854107
4108 The broad category of the error.
4109
40864110 default: permission_error
40874111
40884112 - `message: string`
40894113
4114 A human-readable explanation of the error. Its wording can change, so don't match on it.
4115
40904116 default: Permission denied
40914117
40924118 - `BetaNotFoundError object`
from line 4119
40934119
40944120 - `type: "not_found_error"`
40954121
4122 The broad category of the error.
4123
40964124 default: not_found_error
40974125
40984126 - `message: string`
40994127
4128 A human-readable explanation of the error. Its wording can change, so don't match on it.
4129
41004130 default: Not found
41014131
41024132 - `BetaRateLimitError object`
from line 4133
41034133
41044134 - `type: "rate_limit_error"`
41054135
4136 The broad category of the error.
4137
41064138 default: rate_limit_error
41074139
41084140 - `message: string`
41094141
4142 A human-readable explanation of the error. Its wording can change, so don't match on it.
4143
41104144 default: Rate limited
41114145
41124146 - `BetaGatewayTimeoutError object`
from line 4147
41134147
41144148 - `type: "timeout_error"`
41154149
4150 The broad category of the error.
4151
41164152 default: timeout_error
41174153
41184154 - `message: string`
41194155
4156 A human-readable explanation of the error. Its wording can change, so don't match on it.
4157
41204158 default: Request timeout
41214159
41224160 - `BetaAPIError object`
from line 4161
41234161
41244162 - `type: "api_error"`
41254163
4164 The broad category of the error.
4165
41264166 default: api_error
41274167
41284168 - `message: string`
41294169
4170 A human-readable explanation of the error. Its wording can change, so don't match on it.
4171
41304172 default: Internal server error
41314173
41324174 - `BetaOverloadedError object`
from line 4175
41334175
41344176 - `type: "overloaded_error"`
41354177
4178 The broad category of the error.
4179
41364180 default: overloaded_error
41374181
41384182 - `message: string`
4183
4184 A human-readable explanation of the error. Its wording can change, so don't match on it.
41394185
41404186 default: Overloaded
41414187
api/beta/messages/count_tokens Changed · +18 / -2 lines
from line 131
131131
132132 - `"webhooks-2026-10-07"`
133133
134 - `"admin-user-sign-out-2026-10-08"`
135
134136 - `"message-threads-2026-08-12"`
135137
136138 - `"analytics-usage-cost-2026-08-24"`
from line 3116
31143116
31153117 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31163118
3119 - `"claude-fable-5-2"`
3120
3121 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3122
3123 - `"claude-mythos-5-2"`
3124
3125 Built for the most demanding cybersecurity and life sciences research, available through verification programs
3126
31173127 - `"claude-haiku-5-5"`
31183128
31193129 Fastest model for high-volume, real-time tasks
from line 3474
34643474 Accepted in `messages[].content` and not rendered into the prompt; not
34653475 validated against the request's `fallbacks` chain or top-level `model`.
34663476
3467 Echo the assistant turn back verbatim, including this block in its
3477 When you send the assistant turn back, keep this block in its
34683478 original position. The block marks the boundary between content produced
34693479 before and after a fallback hop, and the server relies on that boundary
34703480 to validate the turn: when thinking runs flank the boundary, omitting
from line 3481
34713481 the block merges them into one span the server cannot validate (the
34723482 request is rejected), and moving it into the middle of a single run is
34733483 likewise rejected; between non-thinking blocks the block's placement has
3474 no validation effect.
3484 no effect on thinking validation.
3485
3486 Some blocks from before the turn's final `fallback` block must be left
3487 out when you send the turn back, and no `tool_result` is sent for a
3488 `tool_use` block you left out.
3489
3490 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
34753491
34763492 - `type: "fallback"`
34773493
api/beta/messages/create Changed · +27 / -3 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 131
131131
132132 - `"webhooks-2026-10-07"`
133133
134 - `"admin-user-sign-out-2026-10-08"`
135
134136 - `"message-threads-2026-08-12"`
135137
136138 - `"analytics-usage-cost-2026-08-24"`
from line 3128
31263128
31273129 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
31283130
3131 - `"claude-fable-5-2"`
3132
3133 Built for the most ambitious work in coding, enterprise workflows, and the sciences
3134
3135 - `"claude-mythos-5-2"`
3136
3137 Built for the most demanding cybersecurity and life sciences research, available through verification programs
3138
31293139 - `"claude-haiku-5-5"`
31303140
31313141 Fastest model for high-volume, real-time tasks
from line 3486
34763486 Accepted in `messages[].content` and not rendered into the prompt; not
34773487 validated against the request's `fallbacks` chain or top-level `model`.
34783488
3479 Echo the assistant turn back verbatim, including this block in its
3489 When you send the assistant turn back, keep this block in its
34803490 original position. The block marks the boundary between content produced
34813491 before and after a fallback hop, and the server relies on that boundary
34823492 to validate the turn: when thinking runs flank the boundary, omitting
from line 3493
34833493 the block merges them into one span the server cannot validate (the
34843494 request is rejected), and moving it into the middle of a single run is
34853495 likewise rejected; between non-thinking blocks the block's placement has
3486 no validation effect.
3496 no effect on thinking validation.
34873497
3498 Some blocks from before the turn's final `fallback` block must be left
3499 out when you send the turn back, and no `tool_result` is sent for a
3500 `tool_use` block you left out.
3501
3502 See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#continuing-the-conversation) to learn which blocks to keep.
3503
34883504 - `type: "fallback"`
34893505
34903506 - `from: BetaFallbackInfoParam`
from line 7016
70007016
70017017 Citations configuration for fetched documents. Citations are disabled by default.
70027018
7003 - `defer_loading: optional boolean`
70047019
7005 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7006
7007 - `max_content_tokens: optional number or null`
7008
7009 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.
7010
7011 minimum: 1
7012
7013 - `max_uses: optional number or null`
7014
7015 Maximum number of times the tool can be used in the API request.
7016
7017 minimum: 1
7018
7019 - `response_inclusion: optional "full" or "excluded"`
7020
7021 How this tool's result blocks appear in the API respo
api/beta/organization Changed · +928 / -127 lines
### Sign Out User
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 778
778778
779779- `user_profile_id: optional string or null`
780780
781 ID of a user profile to bind the key to. Omit this field for a key that isn't bound to a user profile. Such a key can be attached to a Workspace whatever its user profile. The binding cannot be changed later. A key bound to a user profile can only be attached to a Workspace that has the same user profile.
781 ID of a user profile to bind the key to. A user profile represents one of your customers: bind a customer's key to that customer's user profile. A key bound to a user profile can only be attached to a Workspace that has the same user profile, and the binding cannot be changed later. Omit this field only for your organization's own key, because a key created without a user profile ID can be attached to any Workspace, including another customer's.
782782
783783#### Returns
784784
from line 1738
17381738
17391739 - `"webhooks-2026-10-07"`
17401740
1741 - `"admin-user-sign-out-2026-10-08"`
1742
17411743 - `"message-threads-2026-08-12"`
17421744
17431745 - `"analytics-usage-cost-2026-08-24"`
from line 2148
21462148
21472149 - `"webhooks-2026-10-07"`
21482150
2151 - `"admin-user-sign-out-2026-10-08"`
2152
21492153 - `"message-threads-2026-08-12"`
21502154
21512155 - `"analytics-usage-cost-2026-08-24"`
from line 2469
24652469
24662470 - `"webhooks-2026-10-07"`
24672471
2472 - `"admin-user-sign-out-2026-10-08"`
2473
24682474 - `"message-threads-2026-08-12"`
24692475
24702476 - `"analytics-usage-cost-2026-08-24"`
from line 2793
27872793
27882794 - `"webhooks-2026-10-07"`
27892795
2796 - `"admin-user-sign-out-2026-10-08"`
2797
27902798 - `"message-threads-2026-08-12"`
27912799
27922800 - `"analytics-usage-cost-2026-08-24"`
from line 3195
31873195
31883196 - `"webhooks-2026-10-07"`
31893197
3198 - `"admin-user-sign-out-2026-10-08"`
3199
31903200 - `"message-threads-2026-08-12"`
31913201
31923202 - `"analytics-usage-cost-2026-08-24"`
from line 3523
35133523
35143524 - `"webhooks-2026-10-07"`
35153525
3526 - `"admin-user-sign-out-2026-10-08"`
3527
35163528 - `"message-threads-2026-08-12"`
35173529
35183530 - `"analytics-usage-cost-2026-08-24"`
from line 3958
39463958
39473959 - `"webhooks-2026-10-07"`
39483960
3961 - `"admin-user-sign-out-2026-10-08"`
3962
39493963 - `"message-threads-2026-08-12"`
39503964
39513965 - `"analytics-usage-cost-2026-08-24"`
from line 4279
42654279
42664280 - `"webhooks-2026-10-07"`
42674281
4282 - `"admin-user-sign-out-2026-10-08"`
4283
42684284 - `"message-threads-2026-08-12"`
42694285
42704286 - `"analytics-usage-cost-2026-08-24"`
from line 4618
46024618
46034619 - `"webhooks-2026-10-07"`
46044620
4621 - `"admin-user-sign-out-2026-10-08"`
4622
46054623 - `"message-threads-2026-08-12"`
46064624
46074625 - `"analytics-usage-cost-2026-08-24"`
from line 5029
50115029
50125030 - `"webhooks-2026-10-07"`
50135031
5032 - `"admin-user-sign-out-2026-10-08"`
5033
50145034 - `"message-threads-2026-08-12"`
50155035
50165036 - `"analytics-usage-cost-2026-08-24"`
from line 5364
53445364
53455365 - `"webhooks-2026-10-07"`
53465366
5367 - `"admin-user-sign-out-2026-10-08"`
5368
53475369 - `"message-threads-2026-08-12"`
53485370
53495371 - `"analytics-usage-cost-2026-08-24"`
from line 5583
55615583
55625584 - `"webhooks-2026-10-07"`
55635585
5586 - `"admin-user-sign-out-2026-10-08"`
5587
55645588 - `"message-threads-2026-08-12"`
55655589
55665590 - `"analytics-usage-cost-2026-08-24"`
from line 5792
57685792
57695793 - `"webhooks-2026-10-07"`
57705794
5795 - `"admin-user-sign-out-2026-10-08"`
5796
57715797 - `"message-threads-2026-08-12"`
57725798
57735799 - `"analytics-usage-cost-2026-08-24"`
from line 6473
64476473
64486474 - `"webhooks-2026-10-07"`
64496475
6476 - `"admin-user-sign-out-2026-10-08"`
6477
64506478 - `"message-threads-2026-08-12"`
64516479
64526480 - `"analytics-usage-cost-2026-08-24"`
from line 6744
67166744
67176745 - `"webhooks-2026-10-07"`
67186746
6747 - `"admin-user-sign-out-2026-10-08"`
6748
67196749 - `"message-threads-2026-08-12"`
67206750
67216751 - `"analytics-usage-cost-2026-08-24"`
from line 6977
69476977
69486978 - `"webhooks-2026-10-07"`
69496979
6980 - `"admin-user-sign-out-2026-10-08"`
6981
69506982 - `"message-threads-2026-08-12"`
69516983
69526984 - `"analytics-usage-cost-2026-08-24"`
from line 7211
71797211
71807212 - `"webhooks-2026-10-07"`
71817213
7214 - `"admin-user-sign-out-2026-10-08"`
7215
71827216 - `"message-threads-2026-08-12"`
71837217
71847218 - `"analytics-usage-cost-2026-08-24"`
from line 7463
74297463
74307464 - `"webhooks-2026-10-07"`
74317465
7466 - `"admin-user-sign-out-2026-10-08"`
7467
74327468 - `"message-threads-2026-08-12"`
74337469
74347470 - `"analytics-usage-cost-2026-08-24"`
from line 7702
76667702
76677703 - `"webhooks-2026-10-07"`
76687704
7705 - `"admin-user-sign-out-2026-10-08"`
7706
76697707 - `"message-threads-2026-08-12"`
76707708
76717709 - `"analytics-usage-cost-2026-08-24"`
from line 7950
79127950
79137951 - `"webhooks-2026-10-07"`
79147952
7953 - `"admin-user-sign-out-2026-10-08"`
7954
79157955 - `"message-threads-2026-08-12"`
79167956
79177957 - `"analytics-usage-cost-2026-08-24"`
from line 8170
81308170
81318171 - `"webhooks-2026-10-07"`
81328172
8173 - `"admin-user-sign-out-2026-10-08"`
8174
81338175 - `"message-threads-2026-08-12"`
81348176
81358177 - `"analytics-usage-cost-2026-08-24"`
from line 8609
85678609}
85688610```
85698611
8612### Sign Out User
8613
8614**POST** `/v1/organizations/users/{user_id}/sign_out`
8615
8616Sign a member out of Claude everywhere, without removing them from the organization. This ends their sign-in sessions and removes their trusted devices wherever they use Claude, including other organizations and individual plans. It also ends the OAuth tokens issued to them for this organization, so apps such as Claude Code must sign in again.
8617
8618A token can take up to an hour to stop working, though it almost always stops at once. The member keeps their role and can sign in again right away. To keep them out, remove them from the organization or, if your organization uses single sign-on, block them in your identity provider. Signing out does not end API keys, OAuth tokens that were not issued for this organization, or the member's Claude Code cloud sessions and routines.
8619
8620You cannot sign out the organization's primary owner or the person your API key or token acts for, and a request to sign out another owner, a member with owner permissions, or a membership admin may be refused. A refused request returns a `400` or `403` error that says why. If the request returns `503`, send it again to finish; anything already ended stays ended.
8621
8622Every request must include the beta header `anthropic-beta: admin-user-sign-out-2026-10-08`. A request without it returns `400`. Sign-out is in beta for Claude Enterprise organizations. In an organization where it is not enabled, a request returns `400` with `error_code` `organization_not_enrolled_in_beta`. In a Claude Enterprise organization, an API key needs the `write:members` scope; a key without it gets `403`.
8623
8624#### Path parameters
8625
8626- `user_id: string`
8627
8628 ID of the User.
8629
8630#### Headers
8631
8632- `"anthropic-version": optional string`
8633
8634 The version of the Claude API you want to use.
8635
8636 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
8637
8638- `"anthropic-beta": array of AnthropicBeta`
8639
8640 This endpoint is in beta: requests must send `admin-user-sign-out-2026-10-08` in this header.
8641
8642 - `string`
8643
8644 - `"message-batches-2024-09-24"`
8645
8646 - `"prompt-caching-2024-07-31"`
8647
8648 - `"computer-use-2024-10-22"`
8649
8650 - `"computer-use-2025-01-24"`
8651
8652 - `"pdfs-2024-09-25"`
8653
8654 - `"token-counting-2024-11-01"`
8655
8656 - `"token-efficient-tools-2025-02-19"`
8657
8658 - `"output-128k-2025-02-19"`
8659
8660 - `"files-api-2025-04-14"`
8661
8662 - `"mcp-client-2025-04-04"`
8663
8664 - `"mcp-client-2025-11-20"`
8665
8666 - `"dev-full-thinking-2025-05-14"`
8667
8668 - `"interleaved-thinking-2025-05-14"`
8669
8670 - `"code-execution-2025-05-22"`
8671
8672 - `"extended-cache-ttl-2025-04-11"`
8673
8674 - `"context-1m-2025-08-07"`
8675
8676 - `"context-management-2025-06-27"`
8677
8678 - `"model-context-window-exceeded-2025-08-26"`
8679
8680 - `"skills-2025-10-02"`
8681
8682 - `"fast-mode-2026-02-01"`
8683
8684 - `"output-300k-2026-03-24"`
8685
8686 - `"user-profiles-2026-03-24"`
8687
8688 - `"user-profiles-2026-08-18"`
8689
8690 - `"user-profiles-2026-09-04"`
8691
8692 - `"advisor-tool-2026-03-01"`
8693
8694 - `"managed-agents-2026-04-01"`
8695
8696 - `"cache-diagnosis-2026-04-07"`
8697
8698 - `"dreaming-2026-04-21"`
8699
8700 - `"thinking-token-count-2026-05-13"`
8701
8702 - `"server-side-fallback-2026-06-01"`
8703
8704 - `"server-side-fallback-2026-07-01"`
8705
8706 - `"fallback-credit-2026-06-01"`
8707
8708 - `"fallback-credit-2026-07-01"`
8709
8710 - `"agent-memory-2026-07-22"`
8711
8712 - `"mid-conversation-tool-changes-2026-07-01"`
8713
8714 - `"compact-2026-01-12"`
8715
8716 - `"computer-use-2025-11-24"`
8717
8718 - `"mcp-tunnels-2026-06-22"`
8719
8720 - `"structured-outputs-2025-11-13"`
8721
8722 - `"task-budgets-2026-03-13"`
8723
8724 - `"thinking-display-updates-2026-08-18"`
8725
8726 - `"ce-user-management-2026-07-13"`
8727
8728 - `"mid-conversation-output-config-2026-07-01"`
8729
8730 - `"thinking-binding-controls-2026-08-01"`
8731
8732 - `"mid-conversation-system-clear-at-2026-08-21"`
8733
8734 - `"compact-2026-09-04"`
8735
8736 - `"inline-tools-2026-09-15"`
8737
8738 - `"mcp-client-2026-09-15"`
8739
8740 - `"ce-plugins-2026-09-01"`
8741
8742 - `"spend-limit-reads-2026-09-26"`
8743
8744 - `"telemetry-destinations-2026-08-11"`
8745
8746 - `"webhooks-2026-10-07"`
8747
8748 - `"admin-user-sign-out-2026-10-08"`
8749
8750 - `"message-threads-2026-08-12"`
8751
8752 - `"analytics-usage-cost-2026-08-24"`
8753
8754 - `"experimental-claude-tag-2026-10-21"`
8755
8756#### Returns
8757
8758- `BetaOrganizationUser object`
8759
8760 - `type: "user"`
8761
8762 Object type.
8763
8764 For Users, this is always `"user"`.
8765
8766 default: user
8767
8768 - `id: string`
8769
8770 ID of the User.
8771
8772 - `added_at: string`
8773
8774 RFC 3339 datetime string indicating when the User joined the Organization.
8775
8776 format: date-time
8777
8778 - `email: string`
8779
8780 Email of the User.
8781
8782 - `name: string`
8783
8784 Name of the User.
8785
8786 - `role: BetaOrganizationRole`
8787
8788 Organization role of the User.
8789
8790 - `"admin"`
8791
8792 - `"billing"`
8793
8794 - `"claude_code_user"`
8795
8796 - `"developer"`
8797
8798 - `"managed"`
8799
8800 - `"membership_admin"`
8801
8802 - `"owner"`
8803
8804 - `"primary_owner"`
8805
8806 - `"user"`
8807
8808#### Example
8809
8810```bash
8811curl https://api.anthropic.com/v1/organizations/users/$USER_ID/sign_out \
8812 -X POST \
8813 -H 'anthropic-version: 2026-10-21' \
8814 -H 'anthropic-beta: admin-user-sign-out-2026-10-08' \
8815 -H "Authorization: Bearer $ANTHROPIC_API_KEY"
8816```
8817
8818##### Response (200)
8819
8820```json
8821{
8822 "id": "user_01WxYzAbCdEfGhJkMnPqRsTu",
8823 "added_at": "2024-10-30T23:58:27.427722Z",
8824 "email": "[email protected]",
8825 "name": "Jane Doe",
8826 "role": "admin",
8827 "type": "user"
8828}
8829```
8830
85708831## Organization › Workspaces
85718832
85728833### List Workspaces
from line 8846
85858846
85868847 ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.
85878848
8849- `ids: optional array of string`
8850
8851 Only the Workspaces with these IDs, at most 100. `include_archived` and `include_default` still apply, and IDs of Workspaces the caller can't list are left out.
8852
85888853- `include_archived: optional boolean`
85898854
85908855 Whether to include Workspaces that have been archived in the response
from line 9154
88899154
88909155 - `"webhooks-2026-10-07"`
88919156
9157 - `"admin-user-sign-out-2026-10-08"`
9158
88929159 - `"message-threads-2026-08-12"`
88939160
88949161 - `"analytics-usage-cost-2026-08-24"`
from line 10998
1073110998
1073210999 - `"webhooks-2026-10-07"`
1073311000
11001 - `"admin-user-sign-out-2026-10-08"`
11002
1073411003 - `"message-threads-2026-08-12"`
1073511004
1073611005 - `"analytics-usage-cost-2026-08-24"`
from line 11215
1094611215
1094711216 - `"webhooks-2026-10-07"`
1094811217
11218 - `"admin-user-sign-out-2026-10-08"`
11219
1094911220 - `"message-threads-2026-08-12"`
1095011221
1095111222 - `"analytics-usage-cost-2026-08-24"`
from line 11448
1117711448
1117811449 - `"webhooks-2026-10-07"`
1117911450
11451 - `"admin-user-sign-out-2026-10-08"`
11452
1118011453 - `"message-threads-2026-08-12"`
1118111454
1118211455 - `"analytics-usage-cost-2026-08-24"`
from line 11658
1138511658
1138611659 - `"webhooks-2026-10-07"`
1138711660
11661 - `"admin-user-sign-out-2026-10-08"`
11662
1138811663 - `"message-threads-2026-08-12"`
1138911664
1139011665 - `"analytics-usage-cost-2026-08-24"`
from line 11885
1161011885
1161111886 - `"webhooks-2026-10-07"`
1161211887
11888 - `"admin-user-sign-out-2026-10-08"`
11889
1161311890 - `"message-threads-2026-08-12"`
1161411891
1161511892 - `"analytics-usage-cost-2026-08-24"`
from line 12334
1205712334
1205812335- `context_window: optional array of BetaAnalyticsContextWindow`
1205912336
12060 Restrict usage returned to the specified context window(s).
12337 Restrict usage returned to the specified context window(s). See the `context_window` response field for how a request is classified.
1206112338
1206212339 - `"0-200k"`
1206312340
from line 12545
1226812545
1226912546 - `"webhooks-2026-10-07"`
1227012547
12548 - `"admin-user-sign-out-2026-10-08"`
12549
1227112550 - `"message-threads-2026-08-12"`
1227212551
1227312552 - `"analytics-usage-cost-2026-08-24"`
from line 12603
1232412603
1232512604 Context window used. `null` if not grouping by context window.
1232612605
12606 A request is classified by comparing its prompt size with its model's own long-context boundary, the same boundary that billing uses. The two values are labels for the two classes, not literal ranges: where a model's boundary is below 200k, a request whose prompt exceeds that boundary is reported under `200k-1M`, and a `0-200k` filter does not return it. Where the report cannot determine a model's boundary, it uses 200k instead. Hourly usage stored before this classification took effect keeps its earlier value until it expires. Billed amounts are not affected.
12607
1232712608 - `"0-200k"`
1232812609
1232912610 - `"200k-1M"`
from line 13174
1289313174
1289413175 - `"webhooks-2026-10-07"`
1289513176
13177 - `"admin-user-sign-out-2026-10-08"`
13178
1289613179 - `"message-threads-2026-08-12"`
1289713180
1289813181 - `"analytics-usage-cost-2026-08-24"`
from line 13245
1296213245
1296313246 - `model: string or null`
1296413247
12965 Model name used. `null` if not grouping by description or for non-token costs.
13248 Model name used. `null` if not grouping by description, for non-token costs, or for token costs with no model ID.
1296613249
1296713250 - `service_tier: "batch" or "standard" or null`
1296813251
from line 13492
1320913492
1321013493 - `"webhooks-2026-10-07"`
1321113494
13495 - `"admin-user-sign-out-2026-10-08"`
13496
1321213497 - `"message-threads-2026-08-12"`
1321313498
1321413499 - `"analytics-usage-cost-2026-08-24"`
from line 13708
1342313708
1342413709 - `"webhooks-2026-10-07"`
1342513710
13711 - `"admin-user-sign-out-2026-10-08"`
13712
1342613713 - `"message-threads-2026-08-12"`
1342713714
1342813715 - `"analytics-usage-cost-2026-08-24"`
from line 13920
1363313920
1363413921 - `"webhooks-2026-10-07"`
1363513922
13923 - `"admin-user-sign-out-2026-10-08"`
13924
1363613925 - `"message-threads-2026-08-12"`
1363713926
1363813927 - `"analytics-usage-cost-2026-08-24"`
from line 14133
1384414133
1384514134 - `"webhooks-2026-10-07"`
1384614135
14136 - `"admin-user-sign-out-2026-10-08"`
14137
1384714138 - `"message-threads-2026-08-12"`
1384814139
1384914140 - `"analytics-usage-cost-2026-08-24"`
from line 14318
1402714318
1402814319 - `"webhooks-2026-10-07"`
1402914320
14321 - `"admin-user-sign-out-2026-10-08"`
14322
1403014323 - `"message-threads-2026-08-12"`
1403114324
1403214325 - `"analytics-usage-cost-2026-08-24"`
from line 14514
1422114514
1422214515 - `"webhooks-2026-10-07"`
1422314516
14517 - `"admin-user-sign-out-2026-10-08"`
14518
1422414519 - `"message-threads-2026-08-12"`
1422514520
1422614521 - `"analytics-usage-cost-2026-08-24"`
from line 14756
1446114756
1446214757 - `"webhooks-2026-10-07"`
1446314758
14759 - `"admin-user-sign-out-2026-10-08"`
14760
1446414761 - `"message-threads-2026-08-12"`
1446514762
1446614763 - `"analytics-usage-cost-2026-08-24"`
from line 14976
1467914976
1468014977 - `"webhooks-2026-10-07"`
1468114978
14979 - `"admin-user-sign-out-2026-10-08"`
14980
1468214981 - `"message-threads-2026-08-12"`
1468314982
1468414983 - `"analytics-usage-cost-2026-08-24"`
from line 15191
1489215191
1489315192 - `"webhooks-2026-10-07"`
1489415193
15194 - `"admin-user-sign-out-2026-10-08"`
15195
1489515196 - `"message-threads-2026-08-12"`
1489615197
1489715198 - `"analytics-usage-cost-2026-08-24"`
from line 17327
1702617327
1702717328- `agent_ids: optional array of string`
1702817329
17029 Filter to usage incurred by sessions of specific Claude Managed Agents agents. Use `group_by[]=agent_id` to break out per-agent values. Claude Developer Platform organizations only.
17330 Filter to usage incurred by sessions of specific Claude Managed Agents agents. Use `group_by[]=agent_id` to break out per-agent values. Claude Platform organizations only.
1703017331
1703117332 maxItems: 100
1703217333
1703317334- `api_key_ids: optional array of string`
1703417335
17035 Filter to usage authenticated by specific API keys, by tagged API key ID (`apikey_...`), whichever identity the usage is attributed to. Include an empty entry (`api_key_ids[]=`) to also match usage that no API key authenticated. Use `group_by[]=api_key_id` to break out per-key values; usage without a key has a null `api_key_id`. Claude Developer Platform organizations only.
17336 Filter to usage authenticated by specific API keys, by tagged API key ID (`apikey_...`), whichever identity the usage is attributed to. Include an empty entry (`api_key_ids[]=`) to also match usage that no API key authenticated. Use `group_by[]=api_key_id` to break out per-key values; usage without a key has a null `api_key_id`. Claude Platform organizations only.
1703617337
1703717338 maxItems: 100
1703817339
1703917340- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1704017341
17041 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude_tag`, so combining this filter with `products[]=claude_tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
17342 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1704217343
1704317344 maxItems: 100
1704417345
from line 17371
1707017371
1707117372- `deployment_ids: optional array of string`
1707217373
17073 Filter to usage incurred by Claude Managed Agents sessions that specific deployments started. Use `group_by[]=deployment_id` to break out per-deployment values. Claude Developer Platform organizations only.
17374 Filter to usage incurred by Claude Managed Agents sessions that specific deployments started. Use `group_by[]=deployment_id` to break out per-deployment values. Claude Platform organizations only.
1707417375
1707517376 maxItems: 100
1707617377
from line 17383
1708217383
1708317384- `environment_ids: optional array of string`
1708417385
17085 Filter to usage incurred by Claude Managed Agents sessions that ran in specific environments. Use `group_by[]=environment_id` to break out per-environment values. Claude Developer Platform organizations only.
17386 Filter to usage incurred by Claude Managed Agents sessions that ran in specific environments. Use `group_by[]=environment_id` to break out per-environment values. Claude Platform organizations only.
1708617387
1708717388 maxItems: 100
1708817389
from line 17421
1712017421
1712117422 - `"model"`
1712217423
17424 - `"organization_id"`
17425
1712317426 - `"product"`
1712417427
1712517428 - `"rbac_group_id"`
from line 17485
1718217485
1718317486 - `"uncached_input_tokens"`
1718417487
17488- `organization_ids: optional array of string`
17489
17490 Filter a parent organization's report to specific child organizations, by organization UUID or `org_` ID; an ID that is not one of its child organizations matches nothing. Requires an API key created at the parent organization level. Use `group_by[]=organization_id` to break out per-organization values.
17491
17492 maxItems: 100
17493
1718517494- `page: optional string`
1718617495
1718717496 Opaque cursor from a previous response's `next_page` field.
from line 17533
1722417533
1722517534- `service_tiers: optional array of BetaAnalyticsServiceTier`
1722617535
17227 Filter to specific service tiers. Use `group_by[]=service_tier` to break out per-tier values. Claude Developer Platform organizations only; matches nothing for a Claude Enterprise organization.
17536 Filter to specific service tiers. Use `group_by[]=service_tier` to break out per-tier values. Claude Platform organizations only; matches nothing for a Claude Enterprise organization.
1722817537
1722917538 maxItems: 100
1723017539
from line 17551
1724217551
1724317552- `session_ids: optional array of string`
1724417553
17245 Filter to usage incurred by specific Claude Managed Agents sessions, by tagged session ID (`sesn_...`). Use `group_by[]=session_id` to break out per-session values. Claude Developer Platform organizations only.
17554 Filter to usage incurred by specific Claude Managed Agents sessions, by tagged session ID (`sesn_...`). Use `group_by[]=session_id` to break out per-session values. Claude Platform organizations only.
1724617555
1724717556 maxItems: 100
1724817557
from line 17583
1727417583
1727517584- `user_profile_ids: optional array of string`
1727617585
17277 Filter to usage attributed to specific user profiles, by tagged user profile ID (`uprof_...`). Use `group_by[]=user_profile_id` to break out per-profile values. Claude Developer Platform organizations only.
17586 Filter to usage attributed to specific user profiles, by tagged user profile ID (`uprof_...`). Use `group_by[]=user_profile_id` to break out per-profile values. Claude Platform organizations only.
1727817587
1727917588 maxItems: 100
1728017589
1728117590- `workspace_ids: optional array of string`
1728217591
17283 Filter to usage in specific workspaces, by tagged workspace ID (`wrkspc_...`). Use `group_by[]=workspace_id` to break out per-workspace values. Claude Developer Platform organizations only; matches nothing for a Claude Enterprise organization.
17592 Filter to usage in specific workspaces, by tagged workspace ID (`wrkspc_...`). Use `group_by[]=workspace_id` to break out per-workspace values. Claude Platform organizations only; matches nothing for a Claude Enterprise organization.
1728417593
1728517594 maxItems: 100
1728617595
from line 17601
1729217601
1729317602 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1729417603
17295- `"anthropic-beta": optional array of AnthropicBeta`
17604- `"anthropic-beta": array of AnthropicBeta`
1729617605
1729717606 This endpoint is in beta: requests must send `analytics-usage-cost-2026-08-24` in this header.
1729817607
from line 17711
1740217711
1740317712 - `"webhooks-2026-10-07"`
1740417713
17714 - `"admin-user-sign-out-2026-10-08"`
17715
1740517716 - `"message-threads-2026-08-12"`
1740617717
1740717718 - `"analytics-usage-cost-2026-08-24"`
from line 17847
1753617847
1753717848 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1753817849
17539 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude_tag`. New categories may be added over time.
17850 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1754017851
1754117852 - `"dm"`
1754217853
from line 17891
1758017891
1758117892 Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
1758217893
17894 - `organization_id: string or null`
17895
17896 UUID of the child organization the usage belongs to, on a parent organization's report across its children. Null unless `organization_id` is in `group_by[]`.
17897
1758317898 - `product: string or null`
1758417899
1758517900 Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude_tag`, and `chat_cowork_unified`. `claude_tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only where Chat and Cowork unified is available. Some unattributed usage is reported as "other".
from line 17925
1761017925
1761117926 - `slack_channel_id: string or null`
1761217927
17613 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
17928 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
1761417929
1761517930 - `speed: BetaAnalyticsSpeed or null`
1761617931
from line 18045
1773018045 "environment_id": "env_017oTjuGedHtjhJauVC5xGJD",
1773118046 "inference_geo": "global",
1773218047 "model": "claude-opus-5-5",
18048 "organization_id": "12345678-1234-5678-1234-567812345678",
1773318049 "product": "chat",
1773418050 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
1773518051 "service_tier": "standard",
from line 18124
1780818124
1780918125- `agent_ids: optional array of string`
1781018126
17811 Filter to usage incurred by sessions of specific Claude Managed Agents agents. Use `group_by[]=agent_id` to break out per-agent values. Claude Developer Platform organizations only.
18127 Filter to usage incurred by sessions of specific Claude Managed Agents agents. Use `group_by[]=agent_id` to break out per-agent values. Claude Platform organizations only.
1781218128
1781318129 maxItems: 100
1781418130
1781518131- `api_key_ids: optional array of string`
1781618132
17817 Filter to usage authenticated by specific API keys, by tagged API key ID (`apikey_...`), whichever identity the usage is attributed to. Include an empty entry (`api_key_ids[]=`) to also match usage that no API key authenticated. Use `group_by[]=api_key_id` to break out per-key values; usage without a key has a null `api_key_id`. Claude Developer Platform organizations only.
18133 Filter to usage authenticated by specific API keys, by tagged API key ID (`apikey_...`), whichever identity the usage is attributed to. Include an empty entry (`api_key_ids[]=`) to also match usage that no API key authenticated. Use `group_by[]=api_key_id` to break out per-key values; usage without a key has a null `api_key_id`. Claude Platform organizations only.
1781818134
1781918135 maxItems: 100
1782018136
1782118137- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1782218138
17823 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude_tag`, so combining this filter with `products[]=claude_tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
18139 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1782418140
1782518141 maxItems: 100
1782618142
from line 18168
1785218168
1785318169- `deployment_ids: optional array of string`
1785418170
17855 Filter to usage incurred by Claude Managed Agents sessions that specific deployments started. Use `group_by[]=deployment_id` to break out per-deployment values. Claude Developer Platform organizations only.
18171 Filter to usage incurred by Claude Managed Agents sessions that specific deployments started. Use `group_by[]=deployment_id` to break out per-deployment values. Claude Platform organizations only.
1785618172
1785718173 maxItems: 100
1785818174
from line 18180
1786418180
1786518181- `environment_ids: optional array of string`
1786618182
17867 Filter to usage incurred by Claude Managed Agents sessions that ran in specific environments. Use `group_by[]=environment_id` to break out per-environment values. Claude Developer Platform organizations only.
18183 Filter to usage incurred by Claude Managed Agents sessions that ran in specific environments. Use `group_by[]=environment_id` to break out per-environment values. Claude Platform organizations only.
1786818184
1786918185 maxItems: 100
1787018186
from line 18220
1790418220
1790518221 - `"model"`
1790618222
18223 - `"organization_id"`
18224
1790718225 - `"product"`
1790818226
1790918227 - `"rbac_group_id"`
from line 18282
1796418282
1796518283 - `"time"`
1796618284
18285- `organization_ids: optional array of string`
18286
18287 Filter a parent organization's report to specific child organizations, by organization UUID or `org_` ID; an ID that is not one of its child organizations matches nothing. Requires an API key created at the parent organization level. Use `group_by[]=organization_id` to break out per-organization values.
18288
18289 maxItems: 100
18290
1796718291- `page: optional string`
1796818292
1796918293 Opaque cursor from a previous response's `next_page` field.
from line 18330
1800618330
1800718331- `service_tiers: optional array of BetaAnalyticsServiceTier`
1800818332
18009 Filter to specific service tiers. Use `group_by[]=service_tier` to break out per-tier values. Claude Developer Platform organizations only; matches nothing for a Claude Enterprise organization.
18333 Filter to specific service tiers. Use `group_by[]=service_tier` to break out per-tier values. Claude Platform organizations only; matches nothing for a Claude Enterprise organization.
1801018334
1801118335 maxItems: 100
1801218336
from line 18348
1802418348
1802518349- `session_ids: optional array of string`
1802618350
18027 Filter to usage incurred by specific Claude Managed Agents sessions, by tagged session ID (`sesn_...`). Use `group_by[]=session_id` to break out per-session values. Claude Developer Platform organizations only.
18351 Filter to usage incurred by specific Claude Managed Agents sessions, by tagged session ID (`sesn_...`). Use `group_by[]=session_id` to break out per-session values. Claude Platform organizations only.
1802818352
1802918353 maxItems: 100
1803018354
from line 18380
1805618380
1805718381- `user_profile_ids: optional array of string`
1805818382
18059 Filter to usage attributed to specific user profiles, by tagged user profile ID (`uprof_...`). Use `group_by[]=user_profile_id` to break out per-profile values. Claude Developer Platform organizations only.
18383 Filter to usage attributed to specific user profiles, by tagged user profile ID (`uprof_...`). Use `group_by[]=user_profile_id` to break out per-profile values. Claude Platform organizations only.
1806018384
1806118385 maxItems: 100
1806218386
1806318387- `workspace_ids: optional array of string`
1806418388
18065 Filter to usage in specific workspaces, by tagged workspace ID (`wrkspc_...`). Use `group_by[]=workspace_id` to break out per-workspace values. Claude Developer Platform organizations only; matches nothing for a Claude Enterprise organization.
18389 Filter to usage in specific workspaces, by tagged workspace ID (`wrkspc_...`). Use `group_by[]=workspace_id` to break out per-workspace values. Claude Platform organizations only; matches nothing for a Claude Enterprise organization.
1806618390
1806718391 maxItems: 100
1806818392
from line 18398
1807418398
1807518399 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1807618400
18077- `"anthropic-beta": optional array of AnthropicBeta`
18401- `"anthropic-beta": array of AnthropicBeta`
1807818402
1807918403 This endpoint is in beta: requests must send `analytics-usage-cost-2026-08-24` in this header.
1808018404
from line 18508
1818418508
1818518509 - `"webhooks-2026-10-07"`
1818618510
18511 - `"admin-user-sign-out-2026-10-08"`
18512
1818718513 - `"message-threads-2026-08-12"`
1818818514
1818918515 - `"analytics-usage-cost-2026-08-24"`
from line 18666
1834018666
1834118667 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1834218668
18343 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude_tag`. New categories may be added over time.
18669 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1834418670
1834518671 - `"dm"`
1834618672
from line 18722
1839618722
1839718723 Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution.
1839818724
18725 - `organization_id: string or null`
18726
18727 UUID of the child organization the usage belongs to, on a parent organization's report across its children. Null unless `organization_id` is in `group_by[]`.
18728
1839918729 - `product: string or null`
1840018730
1840118731 Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude_tag`, and `chat_cowork_unified`. `claude_tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only where Chat and Cowork unified is available. Some unattributed usage is reported as "other".
from line 18756
1842618756
1842718757 - `slack_channel_id: string or null`
1842818758
18429 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
18759 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
1843018760
1843118761 - `speed: BetaAnalyticsSpeed or null`
1843218762
from line 18849
1851918849 "environment_id": "env_017oTjuGedHtjhJauVC5xGJD",
1852018850 "inference_geo": "global",
1852118851 "model": "claude-opus-5-5",
18852 "organization_id": "12345678-1234-5678-1234-567812345678",
1852218853 "product": "chat",
1852318854 "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF",
1852418855 "service_tier": "standard",
from line 18903
1857218903
1857318904- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1857418905
18575 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
18906 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1857618907
1857718908 maxItems: 100
1857818909
from line 19087
1875619087
1875719088 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1875819089
18759 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
19090 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1876019091
1876119092 - `"dm"`
1876219093
from line 19149
1881819149
1881919150 - `slack_channel_id: string or null`
1882019151
18821 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
19152 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
1882219153
1882319154 - `speed: "fast" or "standard" or null`
1882419155
from line 19244
1891319244
1891419245[Legacy] Get per-user token usage across a date range.
1891519246
18916Returns usage per user, ranked by the chosen token metric; `group_by[]` or `bucket_width` splits a user across several rows. Use this to see which users consume the most tokens. Only usage attributed to a user account is included; usage with no user attributed to it, such as Code Review usage and Claude Tag usage in Slack channels, is left out. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
19247Returns usage per user, ranked by the chosen token metric; `group_by[]` or `bucket_width` splits a user across several rows. Use this to see which users consume the most tokens. Only usage attributed to a user account is included, so usage with no user account, such as Code Review usage and Claude Tag usage in Slack channels, is left out. Claude Tag one-to-one direct messages are included, with product `claude-tag`, only for members who have connected a Claude account. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
1891719248
1891819249This endpoint is one of the legacy Claude Enterprise usage and cost reports. For new integrations, use [`GET /v1/organizations/analytics/usage`](https://platform.claude.com/docs/en/api/beta/organization/analytics/usage/list?sdk_languages=http) in the Usage and Cost Analytics API instead. To move an existing integration, see [Migrate from the Claude Enterprise usage and cost reports](https://platform.claude.com/docs/en/manage-claude/usage-cost-analytics-api?sdk_languages=http#migrate-from-enterprise-analytics-reports).
1891919250
from line 19268
1893719268
1893819269- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1893919270
18940 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
19271 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1894119272
1894219273 maxItems: 100
1894319274
from line 19454
1912319454
1912419455 The user this row's usage or cost is attributed to. Always a `user_actor`.
1912519456
19126 - `type: "user_actor"`
19457 - `BetaAnalyticsUserActor object`
1912719458
19128 Actor type. Always `"user_actor"`.
19459 - `type: "user_actor"`
1912919460
19130 - `deleted: boolean`
19461 Actor type. Always `"user_actor"`.
1913119462
19132 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
19463 - `deleted: boolean`
1913319464
19134 - `email_address: string or null`
19465 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
1913519466
19136 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
19467 - `email_address: string or null`
1913719468
19138 - `name: string or null`
19469 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
1913919470
19140 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
19471 - `name: string or null`
1914119472
19142 - `user_id: string`
19473 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
19474
19475 - `user_id: string`
1914319476
19144 Tagged user ID.
19477 Tagged user ID.
1914519478
1914619479 - `cache_creation: BetaCacheCreation`
1914719480
from line 19498
1916519498
1916619499 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1916719500
19168 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
19501 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1916919502
1917019503 - `"dm"`
1917119504
from line 19566
1923319566
1923419567 - `slack_channel_id: string or null`
1923519568
19236 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
19569 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
1923719570
1923819571 - `speed: "fast" or "standard" or null`
1923919572
from line 19695
1936219695
1936319696- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1936419697
19365 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
19698 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1936619699
1936719700 maxItems: 100
1936819701
from line 19867
1953419867
1953519868 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1953619869
19537 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
19870 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1953819871
1953919872 - `"dm"`
1954019873
from line 19937
1960419937
1960519938 - `slack_channel_id: string or null`
1960619939
19607 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
19940 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
1960819941
1960919942 - `speed: "fast" or "standard" or null`
1961019943
from line 20037
1970420037
1970520038[Legacy] Get per-user cost in USD across a date range.
1970620039
19707Returns cost per user, ranked by spend; `group_by[]` or `bucket_width` splits a user across several rows. Use this to see which users account for the most cost. Only cost attributed to a user account is included; cost with no user attributed to it, such as Code Review usage and Claude Tag usage in Slack channels, is left out. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
20040Returns cost per user, ranked by spend; `group_by[]` or `bucket_width` splits a user across several rows. Use this to see which users account for the most cost. Only cost attributed to a user account is included, so cost with no user account, such as Code Review usage and Claude Tag usage in Slack channels, is left out. Claude Tag one-to-one direct messages are included, with product `claude-tag`, only for members who have connected a Claude account. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope.
1970820041
1970920042This endpoint is one of the legacy Claude Enterprise usage and cost reports. For new integrations, use [`GET /v1/organizations/analytics/cost`](https://platform.claude.com/docs/en/api/beta/organization/analytics/cost/list?sdk_languages=http) in the Usage and Cost Analytics API instead. To move an existing integration, see [Migrate from the Claude Enterprise usage and cost reports](https://platform.claude.com/docs/en/manage-claude/usage-cost-analytics-api?sdk_languages=http#migrate-from-enterprise-analytics-reports).
1971020043
from line 20061
1972820061
1972920062- `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory`
1973020063
19731 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values.
20064 Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. Use `group_by[]=claude_tag_category` to break out per-category values.
1973220065
1973320066 maxItems: 100
1973420067
from line 20247
1991420247
1991520248 The user this row's usage or cost is attributed to. Always a `user_actor`.
1991620249
19917 - `type: "user_actor"`
20250 - `BetaAnalyticsUserActor object`
1991820251
19919 Actor type. Always `"user_actor"`.
20252 - `type: "user_actor"`
1992020253
19921 - `deleted: boolean`
20254 Actor type. Always `"user_actor"`.
1992220255
19923 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
20256 - `deleted: boolean`
1992420257
19925 - `email_address: string or null`
20258 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
1992620259
19927 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
20260 - `email_address: string or null`
1992820261
19929 - `name: string or null`
20262 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
1993020263
19931 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
20264 - `name: string or null`
1993220265
19933 - `user_id: string`
20266 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
1993420267
19935 Tagged user ID.
20268 - `user_id: string`
20269
20270 Tagged user ID.
1993620271
1993720272 - `amount: string`
1993820273
from line 20275
1994020275
1994120276 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
1994220277
19943 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
20278 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
1994420279
1994520280 - `"dm"`
1994620281
from line 20351
2001620351
2001720352 - `slack_channel_id: string or null`
2001820353
20019 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
20354 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
2002020355
2002120356 - `speed: "fast" or "standard" or null`
2002220357
from line 20580
2024520580
2024620581 - `"webhooks-2026-10-07"`
2024720582
20583 - `"admin-user-sign-out-2026-10-08"`
20584
2024820585 - `"message-threads-2026-08-12"`
2024920586
2025020587 - `"analytics-usage-cost-2026-08-24"`
from line 21085
2074821085
2074921086 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2075021087
20751- `"anthropic-beta": optional array of AnthropicBeta`
21088- `"anthropic-beta": array of AnthropicBeta`
2075221089
2075321090 This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header.
2075421091
from line 21195
2085821195
2085921196 - `"webhooks-2026-10-07"`
2086021197
21198 - `"admin-user-sign-out-2026-10-08"`
21199
2086121200 - `"message-threads-2026-08-12"`
2086221201
2086321202 - `"analytics-usage-cost-2026-08-24"`
from line 23749
2341023749
2341123750 - `display_name: string`
2341223751
23413 Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`.
23752 Name of the RBAC Role. For a role created by Anthropic, this is Anthropic's name for the access that the role grants. Anthropic may change this name, so to keep a lasting reference to a role, store its `id`.
2341423753
2341523754 - `updated_at: string`
2341623755
from line 23838
2349923838
2350023839 - `display_name: string`
2350123840
23502 Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`.
23841 Name of the RBAC Role. For a role created by Anthropic, this is Anthropic's name for the access that the role grants. Anthropic may change this name, so to keep a lasting reference to a role, store its `id`.
2350323842
2350423843 - `updated_at: string`
2350523844
from line 23925
2358623925 permission entitlement (`permission_*`), or a blanket capability-access
2358723926 mode — `capability_access_all` grants every product-feature entitlement
2358823927 except `inference_hooks_inspection`, which a role holds only through its
23589 own row, and `capability_access_all_ga` grants the generally-available
23590 subset of those as it stands at permission-check time; neither mode grants
23928 own row, and `capability_access_all_ga` grants the subset of those for
23929 stable features as it stands at permission-check time; neither mode grants
2359123930 model-access entitlements. A consumer enumerating a role's per-feature grants should
2359223931 treat a blanket row as granting every product-feature entitlement it
2359323932 covers, or it will under-report the role's effective access. A `connector_tool` grant carries
from line 24076
2373724076returns a 409 with `error_code` `plugin_name_taken` and, when a Plugin holds it,
2373824077that Plugin's ID in `details.plugin_id`. A Plugin going into the organization's
2373924078library marketplace is also refused with a 409 when one of its skills has the name of
23740an organization skill (a skill an administrator uploaded for the whole organization
23741in claude.ai): `error_code` `skill_name_taken`, with that name in
23742`details.skill_name`; rename the skill, or remove the organization skill in
23743claude.ai. A 503 with `error_code`
24079an organization skill that this API does not list: `error_code`
24080`skill_name_taken`, with that name in `details.skill_name`; rename the skill, or
24081remove the organization skill in claude.ai. A 503 with `error_code`
2374424082`registration_pending` means the Plugin and its version were stored (their IDs are
2374524083in `details`) but are not yet usable in claude.ai: do not retry the create (the
2374624084retry would return `plugin_name_taken`); create a version on the stored Plugin
from line 24093
2375524093
2375624094#### Headers
2375724095
23758- `"anthropic-beta": optional array of AnthropicBeta`
24096- `"anthropic-beta": array of AnthropicBeta`
2375924097
2376024098 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2376124099
from line 24203
2386524203
2386624204 - `"webhooks-2026-10-07"`
2386724205
24206 - `"admin-user-sign-out-2026-10-08"`
24207
2386824208 - `"message-threads-2026-08-12"`
2386924209
2387024210 - `"analytics-usage-cost-2026-08-24"`
from line 24405
2406524405
2406624406 How far the served version reaches, or `null` if it is not classified.
2406724407
24068 `remote` means it declares an MCP server or a CLI. `privileged` means it declares no MCP server or CLI, but declares a hook, monitor, language server, or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
24408 `remote` means it declares an MCP server or a CLI, or something that counts as one. `privileged` means it is not `remote`, but declares a hook (of any type, even one that posts to a URL), monitor, language server, Claude Code workflow (any file in a `workflows/` folder at its root counts as one), or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
2406924409
24070 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if it declares an MCP server or a CLI), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, or `contained` where the same files stored today would be `privileged` or `null`.
24410 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if something else it declares makes it `remote`), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, `contained` where the same files stored today would be `privileged`, `remote`, or `null`, or `privileged` where they would be `remote`.
2407124411
2407224412 - `"contained"`
2407324413
from line 24506
2416624506
2416724507#### Headers
2416824508
24169- `"anthropic-beta": optional array of AnthropicBeta`
24509- `"anthropic-beta": array of AnthropicBeta`
2417024510
2417124511 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2417224512
from line 24616
2427624616
2427724617 - `"webhooks-2026-10-07"`
2427824618
24619 - `"admin-user-sign-out-2026-10-08"`
24620
2427924621 - `"message-threads-2026-08-12"`
2428024622
2428124623 - `"analytics-usage-cost-2026-08-24"`
from line 24802
2446024802
2446124803 How far the served version reaches, or `null` if it is not classified.
2446224804
24463 `remote` means it declares an MCP server or a CLI. `privileged` means it declares no MCP server or CLI, but declares a hook, monitor, language server, or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
24805 `remote` means it declares an MCP server or a CLI, or something that counts as one. `privileged` means it is not `remote`, but declares a hook (of any type, even one that posts to a URL), monitor, language server, Claude Code workflow (any file in a `workflows/` folder at its root counts as one), or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
2446424806
24465 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if it declares an MCP server or a CLI), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, or `contained` where the same files stored today would be `privileged` or `null`.
24807 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if something else it declares makes it `remote`), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, `contained` where the same files stored today would be `privileged`, `remote`, or `null`, or `privileged` where they would be `remote`.
2446624808
2446724809 - `"contained"`
2446824810
from line 24898
2455624898cannot be read at that moment, the request fails with a retryable 503 instead.
2455724899When the Plugin is in the organization's
2455824900library marketplace, a version other than the one served is also refused with a 409
24559when one of its skills has a name that an organization skill (one an administrator
24560uploaded for the whole organization in claude.ai) has since taken: `error_code`
24561`skill_name_taken`, with that name in `details.skill_name`. A member-owned Plugin
24562cannot be updated here (403).
24901when an organization skill that this API does not list has since taken the name of
24902one of its skills: `error_code` `skill_name_taken`, with that name in
24903`details.skill_name`. A member-owned Plugin cannot be updated here (403).
2456324904
2456424905This endpoint does not write installation settings; they are written at
2456524906`/v1/organizations/plugins/{plugin_id}/installation_settings/{target}`.
from line 24917
2457624917
2457724918#### Headers
2457824919
24579- `"anthropic-beta": optional array of AnthropicBeta`
24920- `"anthropic-beta": array of AnthropicBeta`
2458024921
2458124922 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2458224923
from line 25027
2468625027
2468725028 - `"webhooks-2026-10-07"`
2468825029
25030 - `"admin-user-sign-out-2026-10-08"`
25031
2468925032 - `"message-threads-2026-08-12"`
2469025033
2469125034 - `"analytics-usage-cost-2026-08-24"`
from line 25219
2487625219
2487725220 How far the served version reaches, or `null` if it is not classified.
2487825221
24879 `remote` means it declares an MCP server or a CLI. `privileged` means it declares no MCP server or CLI, but declares a hook, monitor, language server, or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
25222 `remote` means it declares an MCP server or a CLI, or something that counts as one. `privileged` means it is not `remote`, but declares a hook (of any type, even one that posts to a URL), monitor, language server, Claude Code workflow (any file in a `workflows/` folder at its root counts as one), or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
2488025223
24881 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if it declares an MCP server or a CLI), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, or `contained` where the same files stored today would be `privileged` or `null`.
25224 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if something else it declares makes it `remote`), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, `contained` where the same files stored today would be `privileged`, `remote`, or `null`, or `privileged` where they would be `remote`.
2488225225
2488325226 - `"contained"`
2488425227
from line 25376
2503325376
2503425377#### Headers
2503525378
25036- `"anthropic-beta": optional array of AnthropicBeta`
25379- `"anthropic-beta": array of AnthropicBeta`
2503725380
2503825381 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2503925382
from line 25486
2514325486
2514425487 - `"webhooks-2026-10-07"`
2514525488
25489 - `"admin-user-sign-out-2026-10-08"`
25490
2514625491 - `"message-threads-2026-08-12"`
2514725492
2514825493 - `"analytics-usage-cost-2026-08-24"`
from line 25672
2532725672
2532825673 How far the served version reaches, or `null` if it is not classified.
2532925674
25330 `remote` means it declares an MCP server or a CLI. `privileged` means it declares no MCP server or CLI, but declares a hook, monitor, language server, or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
25675 `remote` means it declares an MCP server or a CLI, or something that counts as one. `privileged` means it is not `remote`, but declares a hook (of any type, even one that posts to a URL), monitor, language server, Claude Code workflow (any file in a `workflows/` folder at its root counts as one), or settings, or has a skill, command, or other Markdown file whose frontmatter pre-approves tools (`allowed-tools` with any value other than an empty one or one that names only `AskUserQuestion`, `TodoWrite`, and `ToolSearch`). Otherwise it is `contained`.
2533125676
25332 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if it declares an MCP server or a CLI), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, or `contained` where the same files stored today would be `privileged` or `null`.
25677 If the frontmatter of a skill, command, or other Markdown file that could change the value could not be read, or was past a size limit, the version is `null` or `privileged` (or `remote`, if something else it declares makes it `remote`), not `contained`. The value is normally worked out when a version is stored, under the rules of that time, so an older version can be `null`, `contained` where the same files stored today would be `privileged`, `remote`, or `null`, or `privileged` where they would be `remote`.
2533325678
2533425679 - `"contained"`
2533525680
from line 25762
2541725762
2541825763Permanently delete a Plugin and every version it holds, exactly as when an
2541925764administrator deletes it in claude.ai. The Plugin may belong to the organization or
25420to a member, including a member who has since left the organization.
25765to a member, including a member who has since left the organization. Do not delete a
25766Plugin only because your pipeline did not create it: a member or an administrator
25767might have added it in claude.ai.
2542125768
2542225769An organization-owned Plugin's installation settings go with it; a member-owned
2542325770Plugin's shares are withdrawn and its owner no longer has it.
from line 25787
2544025787
2544125788#### Headers
2544225789
25443- `"anthropic-beta": optional array of AnthropicBeta`
25790- `"anthropic-beta": array of AnthropicBeta`
2544425791
2544525792 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2544625793
from line 25897
2555025897
2555125898 - `"webhooks-2026-10-07"`
2555225899
25900 - `"admin-user-sign-out-2026-10-08"`
25901
2555325902 - `"message-threads-2026-08-12"`
2555425903
2555525904 - `"analytics-usage-cost-2026-08-24"`
from line 25956
2560725956Only a Plugin in a `manual` marketplace takes uploads; a Plugin synchronized from
2560825957a repository gets its versions from the repository. When the Plugin is in the
2560925958organization's library marketplace, a version that adds a skill with the name of an
25610organization skill (a skill an administrator uploaded for the whole organization in
25611claude.ai) is refused with a 409: `error_code` `skill_name_taken`, with that name in
25612`details.skill_name`. A 503 with `error_code`
25959organization skill that this API does not list is refused with a 409: `error_code`
25960`skill_name_taken`, with that name in `details.skill_name`. A 503 with `error_code`
2561325961`registration_pending` means the version was stored but is not yet usable; a later
2561425962version create on the Plugin completes it.
2561525963
from line 25976
2562825976
2562925977#### Headers
2563025978
25631- `"anthropic-beta": optional array of AnthropicBeta`
25979- `"anthropic-beta": array of AnthropicBeta`
2563225980
2563325981 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2563425982
from line 26086
2573826086
2573926087 - `"webhooks-2026-10-07"`
2574026088
26089 - `"admin-user-sign-out-2026-10-08"`
26090
2574126091 - `"message-threads-2026-08-12"`
2574226092
2574326093 - `"analytics-usage-cost-2026-08-24"`
from line 26218
2586826218
2586926219 - `description: string or null`
2587026220
25871 The manifest's description; null when it declares none.
26221 The manifest's description; null when it declares none. The value can be longer than 500 characters, the limit on `description` in an uploaded manifest. A description that the manifest takes from a `SKILL.md` is cut to its first 500 characters. So if the manifest's description is the first 500 characters of exactly one distinct skill `description` in `components`, that skill `description` is returned instead.
2587226222
2587326223 - `display_name: string or null`
2587426224
from line 26331
2598126331
2598226332#### Headers
2598326333
25984- `"anthropic-beta": optional array of AnthropicBeta`
26334- `"anthropic-beta": array of AnthropicBeta`
2598526335
2598626336 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2598726337
from line 26441
2609126441
2609226442 - `"webhooks-2026-10-07"`
2609326443
26444 - `"admin-user-sign-out-2026-10-08"`
26445
2609426446 - `"message-threads-2026-08-12"`
2609526447
2609626448 - `"analytics-usage-cost-2026-08-24"`
from line 26561
2620926561
2621026562 - `description: string or null`
2621126563
26212 The manifest's description; null when it declares none.
26564 The manifest's description; null when it declares none. The value can be longer than 500 characters, the limit on `description` in an uploaded manifest. A description that the manifest takes from a `SKILL.md` is cut to its first 500 characters. So if the manifest's description is the first 500 characters of exactly one distinct skill `description` in `components`, that skill `description` is returned instead.
2621326565
2621426566 - `display_name: string or null`
2621526567
from line 26668
2631626668
2631726669#### Headers
2631826670
26319- `"anthropic-beta": optional array of AnthropicBeta`
26671- `"anthropic-beta": array of AnthropicBeta`
2632026672
2632126673 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2632226674
from line 26778
2642626778
2642726779 - `"webhooks-2026-10-07"`
2642826780
26781 - `"admin-user-sign-out-2026-10-08"`
26782
2642926783 - `"message-threads-2026-08-12"`
2643026784
2643126785 - `"analytics-usage-cost-2026-08-24"`
from line 26898
2654426898
2654526899 - `description: string or null`
2654626900
26547 The manifest's description; null when it declares none.
26901 The manifest's description; null when it declares none. The value can be longer than 500 characters, the limit on `description` in an uploaded manifest. A description that the manifest takes from a `SKILL.md` is cut to its first 500 characters. So if the manifest's description is the first 500 characters of exactly one distinct skill `description` in `components`, that skill `description` is returned instead.
2654826902
2654926903 - `display_name: string or null`
2655026904
from line 27012
2665827012
2665927013#### Headers
2666027014
26661- `"anthropic-beta": optional array of AnthropicBeta`
27015- `"anthropic-beta": array of AnthropicBeta`
2666227016
2666327017 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2666427018
from line 27122
2676827122
2676927123 - `"webhooks-2026-10-07"`
2677027124
27125 - `"admin-user-sign-out-2026-10-08"`
27126
2677127127 - `"message-threads-2026-08-12"`
2677227128
2677327129 - `"analytics-usage-cost-2026-08-24"`
from line 27192
2683627192
2683727193#### Headers
2683827194
26839- `"anthropic-beta": optional array of AnthropicBeta`
27195- `"anthropic-beta": array of AnthropicBeta`
2684027196
2684127197 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2684227198
from line 27302
2694627302
2694727303 - `"webhooks-2026-10-07"`
2694827304
27305 - `"admin-user-sign-out-2026-10-08"`
27306
2694927307 - `"message-threads-2026-08-12"`
2695027308
2695127309 - `"analytics-usage-cost-2026-08-24"`
from line 27451
2709327451
2709427452#### Headers
2709527453
27096- `"anthropic-beta": optional array of AnthropicBeta`
27454- `"anthropic-beta": array of AnthropicBeta`
2709727455
2709827456 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2709927457
from line 27561
2720327561
2720427562 - `"webhooks-2026-10-07"`
2720527563
27564 - `"admin-user-sign-out-2026-10-08"`
27565
2720627566 - `"message-threads-2026-08-12"`
2720727567
2720827568 - `"analytics-usage-cost-2026-08-24"`
from line 27727
2736727727
2736827728#### Headers
2736927729
27370- `"anthropic-beta": optional array of AnthropicBeta`
27730- `"anthropic-beta": array of AnthropicBeta`
2737127731
2737227732 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2737327733
from line 27837
2747727837
2747827838 - `"webhooks-2026-10-07"`
2747927839
27840 - `"admin-user-sign-out-2026-10-08"`
27841
2748027842 - `"message-threads-2026-08-12"`
2748127843
2748227844 - `"analytics-usage-cost-2026-08-24"`
from line 27977
2761527977
2761627978#### Headers
2761727979
27618- `"anthropic-beta": optional array of AnthropicBeta`
27980- `"anthropic-beta": array of AnthropicBeta`
2761927981
2762027982 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2762127983
from line 28087
2772528087
2772628088 - `"webhooks-2026-10-07"`
2772728089
28090 - `"admin-user-sign-out-2026-10-08"`
28091
2772828092 - `"message-threads-2026-08-12"`
2772928093
2773028094 - `"analytics-usage-cost-2026-08-24"`
from line 28153
2778928153
2779028154- `next_page: string or null`
2779128155
27792 Token to provide in as `page` in the subsequent request to retrieve the next page of data.
28156 Token to provide in as `page` in the subsequent request to retrieve the next page of data. A page may hold fewer than `limit` shares, even none, while this is set; keep following it until it is null.
2779328157
2779428158#### Example
2779528159
from line 28244
2788028244
2788128245#### Headers
2788228246
27883- `"anthropic-beta": optional array of AnthropicBeta`
28247- `"anthropic-beta": array of AnthropicBeta`
2788428248
2788528249 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2788628250
from line 28354
2799028354
2799128355 - `"webhooks-2026-10-07"`
2799228356
28357 - `"admin-user-sign-out-2026-10-08"`
28358
2799328359 - `"message-threads-2026-08-12"`
2799428360
2799528361 - `"analytics-usage-cost-2026-08-24"`
from line 28523
2815728523
2815828524#### Headers
2815928525
28160- `"anthropic-beta": optional array of AnthropicBeta`
28526- `"anthropic-beta": array of AnthropicBeta`
2816128527
2816228528 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2816328529
from line 28633
2826728633
2826828634 - `"webhooks-2026-10-07"`
2826928635
28636 - `"admin-user-sign-out-2026-10-08"`
28637
2827028638 - `"message-threads-2026-08-12"`
2827128639
2827228640 - `"analytics-usage-cost-2026-08-24"`
from line 28792
2842428792
2842528793#### Headers
2842628794
28427- `"anthropic-beta": optional array of AnthropicBeta`
28795- `"anthropic-beta": array of AnthropicBeta`
2842828796
2842928797 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2843028798
from line 28902
2853428902
2853528903 - `"webhooks-2026-10-07"`
2853628904
28905 - `"admin-user-sign-out-2026-10-08"`
28906
2853728907 - `"message-threads-2026-08-12"`
2853828908
2853928909 - `"analytics-usage-cost-2026-08-24"`
from line 29083
2871329083
2871429084#### Headers
2871529085
28716- `"anthropic-beta": optional array of AnthropicBeta`
29086- `"anthropic-beta": array of AnthropicBeta`
2871729087
2871829088 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2871929089
from line 29193
2882329193
2882429194 - `"webhooks-2026-10-07"`
2882529195
29196 - `"admin-user-sign-out-2026-10-08"`
29197
2882629198 - `"message-threads-2026-08-12"`
2882729199
2882829200 - `"analytics-usage-cost-2026-08-24"`
from line 29361
2898929361
2899029362#### Headers
2899129363
28992- `"anthropic-beta": optional array of AnthropicBeta`
29364- `"anthropic-beta": array of AnthropicBeta`
2899329365
2899429366 This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header.
2899529367
from line 29471
2909929471
2910029472 - `"webhooks-2026-10-07"`
2910129473
29474 - `"admin-user-sign-out-2026-10-08"`
29475
2910229476 - `"message-threads-2026-08-12"`
2910329477
2910429478 - `"analytics-usage-cost-2026-08-24"`
from line 29733
2935929733
2936029734 - `"webhooks-2026-10-07"`
2936129735
29736 - `"admin-user-sign-out-2026-10-08"`
29737
2936229738 - `"message-threads-2026-08-12"`
2936329739
2936429740 - `"analytics-usage-cost-2026-08-24"`
from line 30216
2984030216
2984130217 - `"webhooks-2026-10-07"`
2984230218
30219 - `"admin-user-sign-out-2026-10-08"`
30220
2984330221 - `"message-threads-2026-08-12"`
2984430222
2984530223 - `"analytics-usage-cost-2026-08-24"`
from line 30577
3019930577
3020030578 - `"webhooks-2026-10-07"`
3020130579
30580 - `"admin-user-sign-out-2026-10-08"`
30581
3020230582 - `"message-threads-2026-08-12"`
3020330583
3020430584 - `"analytics-usage-cost-2026-08-24"`
from line 30933
3055330933
3055430934 - `"webhooks-2026-10-07"`
3055530935
30936 - `"admin-user-sign-out-2026-10-08"`
30937
3055630938 - `"message-threads-2026-08-12"`
3055730939
3055830940 - `"analytics-usage-cost-2026-08-24"`
from line 31423
3104131423
3104231424 - `"webhooks-2026-10-07"`
3104331425
31426 - `"admin-user-sign-out-2026-10-08"`
31427
3104431428 - `"message-threads-2026-08-12"`
3104531429
3104631430 - `"analytics-usage-cost-2026-08-24"`
from line 31592
3120831592
3120931593 - `"webhooks-2026-10-07"`
3121031594
31595 - `"admin-user-sign-out-2026-10-08"`
31596
3121131597 - `"message-threads-2026-08-12"`
3121231598
3121331599 - `"analytics-usage-cost-2026-08-24"`
from line 31797
3141131797
3141231798 - `"webhooks-2026-10-07"`
3141331799
31800 - `"admin-user-sign-out-2026-10-08"`
31801
3141431802 - `"message-threads-2026-08-12"`
3141531803
3141631804 - `"analytics-usage-cost-2026-08-24"`
from line 31996
3160831996
3160931997 - `"webhooks-2026-10-07"`
3161031998
31999 - `"admin-user-sign-out-2026-10-08"`
32000
3161132001 - `"message-threads-2026-08-12"`
3161232002
3161332003 - `"analytics-usage-cost-2026-08-24"`
from line 32189
3179932189
3180032190 - `"webhooks-2026-10-07"`
3180132191
32192 - `"admin-user-sign-out-2026-10-08"`
32193
3180232194 - `"message-threads-2026-08-12"`
3180332195
3180432196 - `"analytics-usage-cost-2026-08-24"`
from line 32257
3186532257
3186632258 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3186732259
31868- `"anthropic-beta": optional array of AnthropicBeta`
32260- `"anthropic-beta": array of AnthropicBeta`
3186932261
3187032262 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3187132263
from line 32367
3197532367
3197632368 - `"webhooks-2026-10-07"`
3197732369
32370 - `"admin-user-sign-out-2026-10-08"`
32371
3197832372 - `"message-threads-2026-08-12"`
3197932373
3198032374 - `"analytics-usage-cost-2026-08-24"`
from line 32377
3198332377
3198432378#### Body parameters
3198532379
31986- `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
32380- `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3198732381
3198832382 The event types to deliver to the endpoint. Must list at least one.
3198932383
from line 32385
3199132385
3199232386 - `"user_profile.enforcement_action_resolved"`
3199332387
32388 - `"user_profile.program_status_updated"`
32389
3199432390- `url: string`
3199532391
3199632392 The HTTPS URL that deliveries are sent to.
from line 32425
3202932425
3203032426 Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.
3203132427
32032 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
32428 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3203332429
3203432430 The event types delivered to the endpoint.
3203532431
from line 32433
3203732433
3203832434 - `"user_profile.enforcement_action_resolved"`
3203932435
32436 - `"user_profile.program_status_updated"`
32437
3204032438 - `name: string`
3204132439
3204232440 A short label for the endpoint. An empty string when none was given.
from line 32539
3214132539
3214232540 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3214332541
32144- `"anthropic-beta": optional array of AnthropicBeta`
32542- `"anthropic-beta": array of AnthropicBeta`
3214532543
3214632544 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3214732545
from line 32649
3225132649
3225232650 - `"webhooks-2026-10-07"`
3225332651
32652 - `"admin-user-sign-out-2026-10-08"`
32653
3225432654 - `"message-threads-2026-08-12"`
3225532655
3225632656 - `"analytics-usage-cost-2026-08-24"`
from line 32681
3228132681
3228232682 Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.
3228332683
32284 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
32684 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3228532685
3228632686 The event types delivered to the endpoint.
3228732687
from line 32689
3228932689
3229032690 - `"user_profile.enforcement_action_resolved"`
3229132691
32692 - `"user_profile.program_status_updated"`
32693
3229232694 - `name: string`
3229332695
3229432696 A short label for the endpoint. An empty string when none was given.
from line 32783
3238132783
3238232784 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3238332785
32384- `"anthropic-beta": optional array of AnthropicBeta`
32786- `"anthropic-beta": array of AnthropicBeta`
3238532787
3238632788 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3238732789
from line 32893
3249132893
3249232894 - `"webhooks-2026-10-07"`
3249332895
32896 - `"admin-user-sign-out-2026-10-08"`
32897
3249432898 - `"message-threads-2026-08-12"`
3249532899
3249632900 - `"analytics-usage-cost-2026-08-24"`
from line 32926
3252232926
3252332927 Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.
3252432928
32525 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
32929 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3252632930
3252732931 The event types delivered to the endpoint.
3252832932
from line 32934
3253032934
3253132935 - `"user_profile.enforcement_action_resolved"`
3253232936
32937 - `"user_profile.program_status_updated"`
32938
3253332939 - `name: string`
3253432940
3253532941 A short label for the endpoint. An empty string when none was given.
from line 33009
3260333009
3260433010 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3260533011
32606- `"anthropic-beta": optional array of AnthropicBeta`
33012- `"anthropic-beta": array of AnthropicBeta`
3260733013
3260833014 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3260933015
from line 33119
3271333119
3271433120 - `"webhooks-2026-10-07"`
3271533121
33122 - `"admin-user-sign-out-2026-10-08"`
33123
3271633124 - `"message-threads-2026-08-12"`
3271733125
3271833126 - `"analytics-usage-cost-2026-08-24"`
from line 33133
3272533133
3272633134 Notes about the endpoint.
3272733135
32728- `enabled_events: optional array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
33136- `enabled_events: optional array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3272933137
3273033138 The event types to deliver to the endpoint. Replaces the whole set; an empty list leaves it unchanged.
3273133139
from line 33141
3273333141
3273433142 - `"user_profile.enforcement_action_resolved"`
3273533143
33144 - `"user_profile.program_status_updated"`
33145
3273633146- `name: optional string`
3273733147
3273833148 A short label for the endpoint.
from line 33186
3277633186
3277733187 Why Anthropic disabled the endpoint automatically. An empty string when the endpoint is enabled, or when you disabled it.
3277833188
32779 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved"`
33189 - `enabled_events: array of "user_profile.enforcement_action_opened" or "user_profile.enforcement_action_resolved" or "user_profile.program_status_updated"`
3278033190
3278133191 The event types delivered to the endpoint.
3278233192
from line 33194
3278433194
3278533195 - `"user_profile.enforcement_action_resolved"`
3278633196
33197 - `"user_profile.program_status_updated"`
33198
3278733199 - `name: string`
3278833200
3278933201 A short label for the endpoint. An empty string when none was given.
from line 33271
3285933271
3286033272 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3286133273
32862- `"anthropic-beta": optional array of AnthropicBeta`
33274- `"anthropic-beta": array of AnthropicBeta`
3286333275
3286433276 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3286533277
from line 33381
3296933381
3297033382 - `"webhooks-2026-10-07"`
3297133383
33384 - `"admin-user-sign-out-2026-10-08"`
33385
3297233386 - `"message-threads-2026-08-12"`
3297333387
3297433388 - `"analytics-usage-cost-2026-08-24"`
from line 33449
3303533449
3303633450 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3303733451
33038- `"anthropic-beta": optional array of AnthropicBeta`
33452- `"anthropic-beta": array of AnthropicBeta`
3303933453
3304033454 This endpoint is in beta: requests must send `webhooks-2026-10-07` in this header.
3304133455
from line 33559
3314533559
3314633560 - `"webhooks-2026-10-07"`
3314733561
33562 - `"admin-user-sign-out-2026-10-08"`
33563
3314833564 - `"message-threads-2026-08-12"`
3314933565
3315033566 - `"analytics-usage-cost-2026-08-24"`
from line 33721
3330533721
3330633722 - `"webhooks-2026-10-07"`
3330733723
33724 - `"admin-user-sign-out-2026-10-08"`
33725
3330833726 - `"message-threads-2026-08-12"`
3330933727
3331033728 - `"analytics-usage-cost-2026-08-24"`
from line 33793
3337533793
3337633794 minLength: 1, maxLength: 128
3337733795
33796 - `reply_mode: optional BetaClaudeTagReplyMode or null`
33797
33798 How Claude takes part in the channel: `automatic`, `mention_only`, `always_awake` or `thread`. Only a channel takes one: an update of a workspace that sends a value is refused, and one that sends null changes nothing. Null never clears it: sent to a channel that stores none it changes nothing, and sent to a channel that stores one it is refused, because a stored reply mode can be changed but never cleared; a caller that wants Claude's default behavior sends `automatic`.
33799
33800 - `BetaClaudeTagReplyModeAutomatic object`
33801
33802 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
33803
33804 - `type: "automatic"`
33805
33806 - `BetaClaudeTagReplyModeMentionOnly object`
33807
33808 Claude replies only when it is @-mentioned.
33809
33810 - `type: "mention_only"`
33811
33812 - `BetaClaudeTagReplyModeAlwaysAwake object`
33813
33814 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
33815
33816 - `type: "always_awake"`
33817
33818 - `BetaClaudeTagReplyModeThread object`
33819
33820 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
33821
33822 - `type: "thread"`
33823
3337833824#### Returns
3337933825
3338033826- `BetaClaudeTagSlackChannel object`
from line 33881
3343533881
3343633882 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3343733883
33884 - `reply_mode: BetaClaudeTagReplyMode or null`
33885
33886 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
33887
33888 - `BetaClaudeTagReplyModeAutomatic object`
33889
33890 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
33891
33892 - `type: "automatic"`
33893
33894 - `BetaClaudeTagReplyModeMentionOnly object`
33895
33896 Claude replies only when it is @-mentioned.
33897
33898 - `type: "mention_only"`
33899
33900 - `BetaClaudeTagReplyModeAlwaysAwake object`
33901
33902 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
33903
33904 - `type: "always_awake"`
33905
33906 - `BetaClaudeTagReplyModeThread object`
33907
33908 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
33909
33910 - `type: "thread"`
33911
3343833912 - `slack: BetaClaudeTagSlackChannelIdentifiers`
3343933913
3344033914 Slack's own identifiers for the channel.
from line 34025
3355134025
3355234026 The settings level `model` comes from.
3355334027
34028 - `reply_mode: BetaClaudeTagSettingSource or null`
34029
34030 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
34031
3355434032 - `updated_at: string`
3355534033
3355634034 Time Claude Tag's record of the channel last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the channel again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 34064
3358634064 "type": "allow"
3358734065 },
3358834066 "instructions": "instructions",
33589 "model": "model"
34067 "model": "model",
34068 "reply_mode": {
34069 "type": "automatic"
34070 }
3359034071 },
3359134072 "slack": {
3359234073 "channel_id": "xx",
from line 34095
3361434095 "model": {
3361534096 "slack_channel_id": "slack_channel_id",
3361634097 "type": "slack_channel"
34098 },
34099 "reply_mode": {
34100 "slack_channel_id": "slack_channel_id",
34101 "type": "slack_channel"
3361734102 }
3361834103 },
3361934104 "type": "slack_channel",
from line 34254
3376934254
3377034255 - `"webhooks-2026-10-07"`
3377134256
34257 - `"admin-user-sign-out-2026-10-08"`
34258
3377234259 - `"message-threads-2026-08-12"`
3377334260
3377434261 - `"analytics-usage-cost-2026-08-24"`
from line 34322
3383534322
3383634323 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3383734324
34325 - `reply_mode: BetaClaudeTagReplyMode or null`
34326
34327 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
34328
34329 - `BetaClaudeTagReplyModeAutomatic object`
34330
34331 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
34332
34333 - `type: "automatic"`
34334
34335 - `BetaClaudeTagReplyModeMentionOnly object`
34336
34337 Claude replies only when it is @-mentioned.
34338
34339 - `type: "mention_only"`
34340
34341 - `BetaClaudeTagReplyModeAlwaysAwake object`
34342
34343 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
34344
34345 - `type: "always_awake"`
34346
34347 - `BetaClaudeTagReplyModeThread object`
34348
34349 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
34350
34351 - `type: "thread"`
34352
3383834353 - `slack: BetaClaudeTagSlackChannelIdentifiers`
3383934354
3384034355 Slack's own identifiers for the channel.
from line 34466
3395134466
3395234467 The settings level `model` comes from.
3395334468
34469 - `reply_mode: BetaClaudeTagSettingSource or null`
34470
34471 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
34472
3395434473 - `updated_at: string`
3395534474
3395634475 Time Claude Tag's record of the channel last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the channel again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 34504
3398534504 "type": "allow"
3398634505 },
3398734506 "instructions": "instructions",
33988 "model": "model"
34507 "model": "model",
34508 "reply_mode": {
34509 "type": "automatic"
34510 }
3398934511 },
3399034512 "slack": {
3399134513 "channel_id": "xx",
from line 34535
3401334535 "model": {
3401434536 "slack_channel_id": "slack_channel_id",
3401534537 "type": "slack_channel"
34538 },
34539 "reply_mode": {
34540 "slack_channel_id": "slack_channel_id",
34541 "type": "slack_channel"
3401634542 }
3401734543 },
3401834544 "type": "slack_channel",
from line 34685
3415934685
3416034686 - `"webhooks-2026-10-07"`
3416134687
34688 - `"admin-user-sign-out-2026-10-08"`
34689
3416234690 - `"message-threads-2026-08-12"`
3416334691
3416434692 - `"analytics-usage-cost-2026-08-24"`
from line 34753
3422534753
3422634754 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3422734755
34756 - `reply_mode: BetaClaudeTagReplyMode or null`
34757
34758 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
34759
34760 - `BetaClaudeTagReplyModeAutomatic object`
34761
34762 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
34763
34764 - `type: "automatic"`
34765
34766 - `BetaClaudeTagReplyModeMentionOnly object`
34767
34768 Claude replies only when it is @-mentioned.
34769
34770 - `type: "mention_only"`
34771
34772 - `BetaClaudeTagReplyModeAlwaysAwake object`
34773
34774 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
34775
34776 - `type: "always_awake"`
34777
34778 - `BetaClaudeTagReplyModeThread object`
34779
34780 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
34781
34782 - `type: "thread"`
34783
3422834784 - `slack: BetaClaudeTagSlackChannelIdentifiers`
3422934785
3423034786 Slack's own identifiers for the channel.
from line 34897
3434134897
3434234898 The settings level `model` comes from.
3434334899
34900 - `reply_mode: BetaClaudeTagSettingSource or null`
34901
34902 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
34903
3434434904 - `updated_at: string`
3434534905
3434634906 Time Claude Tag's record of the channel last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the channel again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 34929
3436934929 "type": "allow"
3437034930 },
3437134931 "instructions": "instructions",
34372 "model": "model"
34932 "model": "model",
34933 "reply_mode": {
34934 "type": "automatic"
34935 }
3437334936 },
3437434937 "slack": {
3437534938 "channel_id": "xx",
from line 34960
3439734960 "model": {
3439834961 "slack_channel_id": "slack_channel_id",
3439934962 "type": "slack_channel"
34963 },
34964 "reply_mode": {
34965 "slack_channel_id": "slack_channel_id",
34966 "type": "slack_channel"
3440034967 }
3440134968 },
3440234969 "type": "slack_channel",
from line 35101
3453435101
3453535102 - `"webhooks-2026-10-07"`
3453635103
35104 - `"admin-user-sign-out-2026-10-08"`
35105
3453735106 - `"message-threads-2026-08-12"`
3453835107
3453935108 - `"analytics-usage-cost-2026-08-24"`
from line 35157
3458835157
3458935158 minLength: 1, maxLength: 128
3459035159
35160 - `reply_mode: optional BetaClaudeTagReplyMode or null`
35161
35162 How Claude takes part in the channel: `automatic`, `mention_only`, `always_awake` or `thread`. Only a channel takes one: an update of a workspace that sends a value is refused, and one that sends null changes nothing. Null never clears it: sent to a channel that stores none it changes nothing, and sent to a channel that stores one it is refused, because a stored reply mode can be changed but never cleared; a caller that wants Claude's default behavior sends `automatic`.
35163
35164 - `BetaClaudeTagReplyModeAutomatic object`
35165
35166 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
35167
35168 - `type: "automatic"`
35169
35170 - `BetaClaudeTagReplyModeMentionOnly object`
35171
35172 Claude replies only when it is @-mentioned.
35173
35174 - `type: "mention_only"`
35175
35176 - `BetaClaudeTagReplyModeAlwaysAwake object`
35177
35178 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
35179
35180 - `type: "always_awake"`
35181
35182 - `BetaClaudeTagReplyModeThread object`
35183
35184 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
35185
35186 - `type: "thread"`
35187
3459135188#### Returns
3459235189
3459335190- `BetaClaudeTagSlackChannel object`
from line 35245
3464835245
3464935246 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3465035247
35248 - `reply_mode: BetaClaudeTagReplyMode or null`
35249
35250 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
35251
35252 - `BetaClaudeTagReplyModeAutomatic object`
35253
35254 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
35255
35256 - `type: "automatic"`
35257
35258 - `BetaClaudeTagReplyModeMentionOnly object`
35259
35260 Claude replies only when it is @-mentioned.
35261
35262 - `type: "mention_only"`
35263
35264 - `BetaClaudeTagReplyModeAlwaysAwake object`
35265
35266 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
35267
35268 - `type: "always_awake"`
35269
35270 - `BetaClaudeTagReplyModeThread object`
35271
35272 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
35273
35274 - `type: "thread"`
35275
3465135276 - `slack: BetaClaudeTagSlackChannelIdentifiers`
3465235277
3465335278 Slack's own identifiers for the channel.
from line 35389
3476435389
3476535390 The settings level `model` comes from.
3476635391
35392 - `reply_mode: BetaClaudeTagSettingSource or null`
35393
35394 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
35395
3476735396 - `updated_at: string`
3476835397
3476935398 Time Claude Tag's record of the channel last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the channel again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 35425
3479635425 "type": "allow"
3479735426 },
3479835427 "instructions": "instructions",
34799 "model": "model"
35428 "model": "model",
35429 "reply_mode": {
35430 "type": "automatic"
35431 }
3480035432 },
3480135433 "slack": {
3480235434 "channel_id": "xx",
from line 35456
3482435456 "model": {
3482535457 "slack_channel_id": "slack_channel_id",
3482635458 "type": "slack_channel"
35459 },
35460 "reply_mode": {
35461 "slack_channel_id": "slack_channel_id",
35462 "type": "slack_channel"
3482735463 }
3482835464 },
3482935465 "type": "slack_channel",
from line 35597
3496135597
3496235598 - `"webhooks-2026-10-07"`
3496335599
35600 - `"admin-user-sign-out-2026-10-08"`
35601
3496435602 - `"message-threads-2026-08-12"`
3496535603
3496635604 - `"analytics-usage-cost-2026-08-24"`
from line 35782
3514435782
3514535783 - `"webhooks-2026-10-07"`
3514635784
35785 - `"admin-user-sign-out-2026-10-08"`
35786
3514735787 - `"message-threads-2026-08-12"`
3514835788
3514935789 - `"analytics-usage-cost-2026-08-24"`
from line 35850
3521035850
3521135851 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3521235852
35853 - `reply_mode: BetaClaudeTagReplyMode or null`
35854
35855 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
35856
35857 - `BetaClaudeTagReplyModeAutomatic object`
35858
35859 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
35860
35861 - `type: "automatic"`
35862
35863 - `BetaClaudeTagReplyModeMentionOnly object`
35864
35865 Claude replies only when it is @-mentioned.
35866
35867 - `type: "mention_only"`
35868
35869 - `BetaClaudeTagReplyModeAlwaysAwake object`
35870
35871 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
35872
35873 - `type: "always_awake"`
35874
35875 - `BetaClaudeTagReplyModeThread object`
35876
35877 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
35878
35879 - `type: "thread"`
35880
3521335881 - `slack: BetaClaudeTagSlackWorkspaceIdentifiers`
3521435882
3521535883 Slack's own identifier for the workspace.
from line 35998
3533035998
3533135999 The settings level `model` comes from.
3533236000
36001 - `reply_mode: BetaClaudeTagSettingSource or null`
36002
36003 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
36004
3533336005 - `updated_at: string`
3533436006
3533536007 Time Claude Tag's record of the workspace last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the workspace again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 36036
3536436036 "type": "allow"
3536536037 },
3536636038 "instructions": "instructions",
35367 "model": "model"
36039 "model": "model",
36040 "reply_mode": {
36041 "type": "automatic"
36042 }
3536836043 },
3536936044 "slack": {
3537036045 "workspace_id": "workspace_id"
from line 36066
3539136066 "model": {
3539236067 "slack_channel_id": "slack_channel_id",
3539336068 "type": "slack_channel"
36069 },
36070 "reply_mode": {
36071 "slack_channel_id": "slack_channel_id",
36072 "type": "slack_channel"
3539436073 }
3539536074 },
3539636075 "type": "slack_workspace",
from line 36216
3553736216
3553836217 - `"webhooks-2026-10-07"`
3553936218
36219 - `"admin-user-sign-out-2026-10-08"`
36220
3554036221 - `"message-threads-2026-08-12"`
3554136222
3554236223 - `"analytics-usage-cost-2026-08-24"`
from line 36284
3560336284
3560436285 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3560536286
36287 - `reply_mode: BetaClaudeTagReplyMode or null`
36288
36289 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
36290
36291 - `BetaClaudeTagReplyModeAutomatic object`
36292
36293 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
36294
36295 - `type: "automatic"`
36296
36297 - `BetaClaudeTagReplyModeMentionOnly object`
36298
36299 Claude replies only when it is @-mentioned.
36300
36301 - `type: "mention_only"`
36302
36303 - `BetaClaudeTagReplyModeAlwaysAwake object`
36304
36305 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
36306
36307 - `type: "always_awake"`
36308
36309 - `BetaClaudeTagReplyModeThread object`
36310
36311 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
36312
36313 - `type: "thread"`
36314
3560636315 - `slack: BetaClaudeTagSlackWorkspaceIdentifiers`
3560736316
3560836317 Slack's own identifier for the workspace.
from line 36432
3572336432
3572436433 The settings level `model` comes from.
3572536434
36435 - `reply_mode: BetaClaudeTagSettingSource or null`
36436
36437 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
36438
3572636439 - `updated_at: string`
3572736440
3572836441 Time Claude Tag's record of the workspace last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the workspace again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 36464
3575136464 "type": "allow"
3575236465 },
3575336466 "instructions": "instructions",
35754 "model": "model"
36467 "model": "model",
36468 "reply_mode": {
36469 "type": "automatic"
36470 }
3575536471 },
3575636472 "slack": {
3575736473 "workspace_id": "workspace_id"
from line 36494
3577836494 "model": {
3577936495 "slack_channel_id": "slack_channel_id",
3578036496 "type": "slack_channel"
36497 },
36498 "reply_mode": {
36499 "slack_channel_id": "slack_channel_id",
36500 "type": "slack_channel"
3578136501 }
3578236502 },
3578336503 "type": "slack_workspace",
from line 36635
3591536635
3591636636 - `"webhooks-2026-10-07"`
3591736637
36638 - `"admin-user-sign-out-2026-10-08"`
36639
3591836640 - `"message-threads-2026-08-12"`
3591936641
3592036642 - `"analytics-usage-cost-2026-08-24"`
from line 36691
3596936691
3597036692 minLength: 1, maxLength: 128
3597136693
36694 - `reply_mode: optional BetaClaudeTagReplyMode or null`
36695
36696 How Claude takes part in the channel: `automatic`, `mention_only`, `always_awake` or `thread`. Only a channel takes one: an update of a workspace that sends a value is refused, and one that sends null changes nothing. Null never clears it: sent to a channel that stores none it changes nothing, and sent to a channel that stores one it is refused, because a stored reply mode can be changed but never cleared; a caller that wants Claude's default behavior sends `automatic`.
36697
36698 - `BetaClaudeTagReplyModeAutomatic object`
36699
36700 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
36701
36702 - `type: "automatic"`
36703
36704 - `BetaClaudeTagReplyModeMentionOnly object`
36705
36706 Claude replies only when it is @-mentioned.
36707
36708 - `type: "mention_only"`
36709
36710 - `BetaClaudeTagReplyModeAlwaysAwake object`
36711
36712 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
36713
36714 - `type: "always_awake"`
36715
36716 - `BetaClaudeTagReplyModeThread object`
36717
36718 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
36719
36720 - `type: "thread"`
36721
3597236722#### Returns
3597336723
3597436724- `BetaClaudeTagSlackWorkspace object`
from line 36779
3602936779
3603036780 The model Claude uses: a model identifier or the name of a model line. The nearest settings level that sets it decides. When none does, Claude uses the product's default model.
3603136781
36782 - `reply_mode: BetaClaudeTagReplyMode or null`
36783
36784 How Claude takes part in the channel. Only a channel stores one, and no settings level passes one on, so it is always null on a workspace. Null on a channel means the channel stores none yet: Claude then follows the reply mode chosen in Slack, if one was, else `automatic`. A stored reply mode can be changed but never cleared.
36785
36786 - `BetaClaudeTagReplyModeAutomatic object`
36787
36788 Claude reads along and joins in when it can help, and pauses on its own in quiet or busy channels.
36789
36790 - `type: "automatic"`
36791
36792 - `BetaClaudeTagReplyModeMentionOnly object`
36793
36794 Claude replies only when it is @-mentioned.
36795
36796 - `type: "mention_only"`
36797
36798 - `BetaClaudeTagReplyModeAlwaysAwake object`
36799
36800 Like `automatic`, but Claude never pauses on its own. Available where it is enabled for the channel.
36801
36802 - `type: "always_awake"`
36803
36804 - `BetaClaudeTagReplyModeThread object`
36805
36806 Every new top-level message in the channel gets its own reply from Claude, in a thread under it. Available where it is enabled for the channel, and only once Claude has been used in the channel.
36807
36808 - `type: "thread"`
36809
3603236810 - `slack: BetaClaudeTagSlackWorkspaceIdentifiers`
3603336811
3603436812 Slack's own identifier for the workspace.
from line 36927
3614936927
3615036928 The settings level `model` comes from.
3615136929
36930 - `reply_mode: BetaClaudeTagSettingSource or null`
36931
36932 The settings level `reply_mode` comes from: the channel when it stores one. With `include_inherited=true` and no stored mode it is `default`.
36933
3615236934 - `updated_at: string`
3615336935
3615436936 Time Claude Tag's record of the workspace last changed. It moves on every change to a setting, and can also move when something no response holds changes, so a later value says to read the workspace again, not that a setting changed. Attaching or detaching a Bundle does not by itself move it.
from line 36963
3618136963 "type": "allow"
3618236964 },
3618336965 "instructions": "instructions",
36184 "model": "model"
36966 "model": "model",
36967 "reply_mode": {
36968 "type": "automatic"
36969 }
3618536970 },
3618636971 "slack": {
3618736972 "workspace_id": "workspace_id"
from line 36993
3620836993 "model": {
3620936994 "slack_channel_id": "slack_channel_id",
3621036995 "type": "slack_channel"
36996 },
36997 "reply_mode": {
36998 "slack_channel_id": "slack_channel_id",
36999 "type": "slack_channel"
3621137000 }
3621237001 },
3621337002 "type": "slack_workspace",
from line 37142
3635337142
3635437143 - `"webhooks-2026-10-07"`
3635537144
37145 - `"admin-user-sign-out-2026-10-08"`
37146
3635637147 - `"message-threads-2026-08-12"`
3635737148
3635837149 - `"analytics-usage-cost-2026-08-24"`
from line 37343
3655237343
3655337344 - `"webhooks-2026-10-07"`
3655437345
37346 - `"admin-user-sign-out-2026-10-08"`
37347
3655537348 - `"message-threads-2026-08-12"`
3655637349
3655737350 - `"analytics-usage-cost-2026-08-24"`
from line 37549
3675637549
3675737550 - `"webhooks-2026-10-07"`
3675837551
37552 - `"admin-user-sign-out-2026-10-08"`
37553
3675937554 - `"message-threads-2026-08-12"`
3676037555
3676137556 - `"analytics-usage-cost-2026-08-24"`
from line 37762
3696737762
3696837763 - `"webhooks-2026-10-07"`
3696937764
37765 - `"admin-user-sign-out-2026-10-08"`
37766
3697037767 - `"message-threads-2026-08-12"`
3697137768
3697237769 - `"analytics-usage-cost-2026-08-24"`
from line 38003
3720638003
3720738004 - `"webhooks-2026-10-07"`
3720838005
38006 - `"admin-user-sign-out-2026-10-08"`
38007
3720938008 - `"message-threads-2026-08-12"`
3721038009
3721138010 - `"analytics-usage-cost-2026-08-24"`
from line 38211
3741238211
3741338212 - `"webhooks-2026-10-07"`
3741438213
38214 - `"admin-user-sign-out-2026-10-08"`
38215
3741538216 - `"message-threads-2026-08-12"`
3741638217
3741738218 - `"analytics-usage-cost-2026-08-24"`
3741838219
api/beta/organization/analytics Changed · +164 / -126 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 882
882882
883883 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
884884
885 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
885 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
886886
887887 - `"dm"`
888888
from line 952
952952
953953 - `slack_channel_id: string or null`
954954
955 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
955 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
956956
957957 - `speed: "fast" or "standard" or null`
958958
from line 996
996996
997997 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
998998
999 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
999 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
10001000
10011001 - `"dm"`
10021002
from line 1066
10661066
10671067 - `slack_channel_id: string or null`
10681068
1069 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
1069 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
10701070
10711071 - `speed: "fast" or "standard" or null`
10721072
from line 1114
11141114
11151115 The user this row's usage or cost is attributed to. Always a `user_actor`.
11161116
1117 - `type: "user_actor"`
1117 - `BetaAnalyticsUserActor object`
11181118
1119 Actor type. Always `"user_actor"`.
1119 - `type: "user_actor"`
11201120
1121 - `deleted: boolean`
1121 Actor type. Always `"user_actor"`.
11221122
1123 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
1123 - `deleted: boolean`
11241124
1125 - `email_address: string or null`
1125 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
11261126
1127 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
1127 - `email_address: string or null`
11281128
1129 - `name: string or null`
1129 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
11301130
1131 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
1131 - `name: string or null`
11321132
1133 - `user_id: string`
1133 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
11341134
1135 Tagged user ID.
1135 - `user_id: string`
11361136
1137 Tagged user ID.
1138
11371139 - `amount: string`
11381140
11391141 Amount (post-discount, pre-credit) in fractional cents (minor units).
from line 1142
11401142
11411143 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
11421144
1143 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
1145 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
11441146
11451147 - `"dm"`
11461148
from line 1218
12161218
12171219 - `slack_channel_id: string or null`
12181220
1219 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
1221 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
12201222
12211223 - `speed: "fast" or "standard" or null`
12221224
from line 2392
23902392
23912393 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
23922394
2393 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
2395 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
23942396
23952397 - `"dm"`
23962398
from line 2454
24522454
24532455 - `slack_channel_id: string or null`
24542456
2455 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
2457 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
24562458
24572459 - `speed: "fast" or "standard" or null`
24582460
from line 2550
25482550
25492551 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
25502552
2551 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
2553 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
25522554
25532555 - `"dm"`
25542556
from line 2612
26102612
26112613 - `slack_channel_id: string or null`
26122614
2613 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
2615 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
26142616
26152617 - `speed: "fast" or "standard" or null`
26162618
from line 2640
26382640
26392641 The user this row's usage or cost is attributed to. Always a `user_actor`.
26402642
2641 - `type: "user_actor"`
2643 - `BetaAnalyticsUserActor object`
26422644
2643 Actor type. Always `"user_actor"`.
2645 - `type: "user_actor"`
26442646
2645 - `deleted: boolean`
2647 Actor type. Always `"user_actor"`.
26462648
2647 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
2649 - `deleted: boolean`
26482650
2649 - `email_address: string or null`
2651 True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation.
26502652
2651 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
2653 - `email_address: string or null`
26522654
2653 - `name: string or null`
2655 The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`).
26542656
2655 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
2657 - `name: string or null`
26562658
2657 - `user_id: string`
2659 The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"`) or null.
26582660
2659 Tagged user ID.
2661 - `user_id: string`
26602662
2663 Tagged user ID.
2664
26612665 - `cache_creation: BetaCacheCreation`
26622666
26632667 The number of input tokens for cache creation.
from line 2684
26802684
26812685 - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null`
26822686
2683 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time.
2687 Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. New categories may be added over time.
26842688
26852689 - `"dm"`
26862690
from line 2752
27482752
27492753 - `slack_channel_id: string or null`
27502754
2751 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled).
2755 Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack, for some Claude Tag usage that has no channel recorded, and for usage recorded before channel attribution was enabled.
27522756
27532757 - `speed: "fast" or "standard" or null`
27542758
from line 5304
53005304
53015305Returns one row per combination of the requested `group_by[]`
53025306dimensions (and time bucket, when `time_bucket_width` is set) that has
5303us
5307usage in the range, ranked by the `order_by` metric or ordered by time
5308bucket; every combination is returned across pages. With no `group_by[]`
5309and no `time_bucket_width`, a single row aggregates the whole range.
5310Includes all usage, whether or not it is attributable to a se