One read of Claude Developer Platformapi-20260925T153714Z
310 pages moved out of 637 read.
Pages moved
310
significant first
Pages read
637
in this capture
Captured
15:37 UTC
Corpus hash
850f99a0d461
corpus-hash
What this read moved
1-25 of 310, page 1 of 13This capture is too large to show at once. Changes 1-25 of 310 are below, significant first; the rest are on the following screens.
api/beta Changed · +5515 / -5691 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 459
459459
460460 Defaults to `20`. Ranges from `1` to `1000`.
461461
462 default: 20, maximum: 1000, minimum: 1
462 default: 20, minimum: 1, maximum: 1000
463463
464464#### Headers
465465
from line 595
595595
596596 - `capabilities: BetaModelCapabilities or null`
597597
598 Model capability information.
598 Object mapping capability names to their support details. Keys are always present for all known capabilities.
599599
600600 - `batch: BetaCapabilitySupport`
601601
from line 615
615615
616616 - `compaction: BetaCompactionCapability or null`
617617
618 Compaction capability details: whether the model accepts the top-level
619 `compaction` request parameter, with one entry per supported
620 `compaction.type` value.
618 Server-side compaction support (the top-level `compaction` parameter) and the accepted `compaction.type` values.
621619
622620 - `summarize: BetaCapabilitySupport`
623621
from line 631
633631
634632 - `clear_thinking_20251015: BetaCapabilitySupport or null`
635633
636 Indicates whether a capability is supported.
634 Whether the clear_thinking_20251015 strategy is supported.
637635
638636 - `clear_tool_uses_20250919: BetaCapabilitySupport or null`
639637
640 Indicates whether a capability is supported.
638 Whether the clear_tool_uses_20250919 strategy is supported.
641639
642640 - `compact_20260112: BetaCapabilitySupport or null`
643641
644 Indicates whether a capability is supported.
642 Whether the compact_20260112 strategy is supported.
645643
646644 - `supported: boolean`
647645
from line 671
673671
674672 - `xhigh: BetaCapabilitySupport or null`
675673
676 Indicates whether a capability is supported.
674 Whether the model supports xhigh effort level.
677675
678676 - `image_input: BetaCapabilitySupport`
679677
from line 981
983981
984982 - `capabilities: BetaModelCapabilities or null`
985983
986 Model capability information.
984 Object mapping capability names to their support details. Keys are always present for all known capabilities.
987985
988986 - `batch: BetaCapabilitySupport`
989987
from line 1001
10031001
10041002 - `compaction: BetaCompactionCapability or null`
10051003
1006 Compaction capability details: whether the model accepts the top-level
1007 `compaction` request parameter, with one entry per supported
1008 `compaction.type` value.
1004 Server-side compaction support (the top-level `compaction` parameter) and the accepted `compaction.type` values.
10091005
10101006 - `summarize: BetaCapabilitySupport`
10111007
from line 1017
10211017
10221018 - `clear_thinking_20251015: BetaCapabilitySupport or null`
10231019
1024 Indicates whether a capability is supported.
1020 Whether the clear_thinking_20251015 strategy is supported.
10251021
10261022 - `clear_tool_uses_20250919: BetaCapabilitySupport or null`
10271023
1028 Indicates whether a capability is supported.
1024 Whether the clear_tool_uses_20250919 strategy is supported.
10291025
10301026 - `compact_20260112: BetaCapabilitySupport or null`
10311027
1032 Indicates whether a capability is supported.
1028 Whether the compact_20260112 strategy is supported.
10331029
10341030 - `supported: boolean`
10351031
from line 1057
10611057
10621058 - `xhigh: BetaCapabilitySupport or null`
10631059
1064 Indicates whether a capability is supported.
1060 Whether the model supports xhigh effort level.
10651061
10661062 - `image_input: BetaCapabilitySupport`
10671063
from line 1442
14461442
14471443 - `document_title: string or null`
14481444
1449 maxLength: 500, minLength: 1
1445 minLength: 1, maxLength: 500
14501446
14511447 - `end_char_index: number`
14521448
from line 1462
14661462
14671463 - `document_title: string or null`
14681464
1469 maxLength: 500, minLength: 1
1465 minLength: 1, maxLength: 500
14701466
14711467 - `end_page_number: number`
14721468
from line 1486
14901486
14911487 - `document_title: string or null`
14921488
1493 maxLength: 500, minLength: 1
1489 minLength: 1, maxLength: 500
14941490
14951491 - `end_block_index: number`
14961492
from line 1510
15141510
15151511 - `title: string or null`
15161512
1517 maxLength: 512, minLength: 1
1513 minLength: 1, maxLength: 512
15181514
15191515 - `url: string`
15201516
from line 1666
16701666
16711667 - `title: optional string or null`
16721668
1673 maxLength: 500, minLength: 1
1669 minLength: 1, maxLength: 500
16741670
16751671 - `BetaSearchResultBlockParam object`
16761672
from line 1730
17341730
17351731 - `name: string`
17361732
1737 maxLength: 200, minLength: 1
1733 minLength: 1, maxLength: 200
17381734
17391735 - `cache_control: optional BetaCacheControlEphemeral or null`
17401736
from line 1766
17701766
17711767 For a toolset member tool_use, the toolset family this member belongs to.
17721768
1773 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
1769 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
17741770
17751771 - `BetaToolResultBlockParam object`
17761772
from line 1802
18061802
18071803 - `tool_name: string`
18081804
1809 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
1805 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
18101806
18111807 - `cache_control: optional BetaCacheControlEphemeral or null`
18121808
from line 1830
18341830
18351831 The caller-assigned identifier for this tab, unique within the inventory.
18361832
1837 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
1833 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
18381834
18391835 - `title: string`
18401836
from line 1856
18601856
18611857 Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
18621858
1863 maxItems: 200, minItems: 1
1859 minItems: 1, maxItems: 200
18641860
18651861 - `BetaBrowserStateChangeTabOpened object`
18661862
from line 1874
18781874
18791875 The `tab_id` of the opened tab, present in `tabs`.
18801876
1881 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
1877 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
18821878
18831879 - `BetaBrowserStateChangeDownloadStarted object`
18841880
from line 1886
18901886
18911887 The caller-assigned identifier for this download, stable across the state changes reporting it.
18921888
1893 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
1889 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
18941890
18951891 - `url: string`
18961892
from line 1907
19111907
19121908 The caller-assigned identifier for this download, stable across the state changes reporting it.
19131909
1914 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
1910 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
19151911
19161912 - `url: string`
19171913
from line 1919
19231919
19241920 Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.
19251921
1926 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
1922 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
19271923
19281924 - `size_bytes: optional number or null`
19291925
from line 1937
19411937
19421938 The caller-assigned identifier for this download, stable across the state changes reporting it.
19431939
1944 maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
1940 minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
19451941
19461942 - `url: string`
19471943
from line 1949
19531949
19541950 The failure or cancellation detail, when known.
19551951
1956 pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096
1952 maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
19571953
19581954 - `is_error: optional boolean`
19591955
from line 1957
19611957
19621958 For a toolset member tool_result, the toolset family of the paired tool_use.
19631959
1964 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
1960 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
19651961
19661962 - `BetaServerToolUseBlockParam object`
19671963
from line 2389
23932389
23942390 - `tool_name: string`
23952391
2396 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
2392 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
23972393
23982394 - `cache_control: optional BetaCacheControlEphemeral or null`
23992395
from line 2581
25852581
25862582 This is how the tool will be called by the model and in `tool_use` blocks.
25872583
2588 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
2584 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
25892585
25902586 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
25912587
from line 2832
28362832
28372833 - `configs: optional BetaBrowserToolsetConfigs or null`
28382834
2839 Per-member configuration for `browser_toolset_20260801`: one
2840 optional field per member tool, keyed by the member name — the same
2841 name the member's `tool_use` blocks carry. Every member is an
2842 accepted key, and a member's defaults apply wherever its key is
2843 absent. Unknown keys are rejected: the field set is this toolset
2844 version's complete member set.
2835 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
28452836
28462837 - `type: optional BetaBrowserTypeConfig or null`
28472838
from line 3453
34623453
34633454 - `configs: optional BetaComputerToolsetConfigs or null`
34643455
3465 Per-member configuration for `computer_toolset_20260801`: one
3466 optional field per member tool, keyed by the member name — the same
3467 name the member's `tool_use` blocks carry. Every member is an
3468 accepted key, and a member's defaults apply wherever its key is
3469 absent. Unknown keys are rejected: the field set is this toolset
3470 version's complete member set.
3456 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
34713457
34723458 - `type: optional BetaComputerTypeConfig or null`
34733459
from line 3807
38213807
38223808 Maximum number of times the tool can be used in the API request.
38233809
3824 exclusiveMinimum: 0
3810 minimum: 1
38253811
38263812 - `strict: optional boolean`
38273813
from line 3823
38373823
38383824 The city of the user.
38393825
3840 maxLength: 255, minLength: 1
3826 minLength: 1, maxLength: 255
38413827
38423828 - `country: optional string or null`
38433829
38443830 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
38453831
3846 maxLength: 2, minLength: 2
3832 minLength: 2, maxLength: 2
38473833
38483834 - `region: optional string or null`
38493835
38503836 The region of the user.
38513837
3852 maxLength: 255, minLength: 1
3838 minLength: 1, maxLength: 255
38533839
38543840 - `timezone: optional string or null`
38553841
38563842 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
38573843
3858 maxLength: 255, minLength: 1
3844 minLength: 1, maxLength: 255
38593845
38603846 - `BetaWebFetchTool20250910 object`
38613847
from line 3887
39013887
39023888 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.
39033889
3904 exclusiveMinimum: 0
3890 minimum: 1
39053891
39063892 - `max_uses: optional number or null`
39073893
39083894 Maximum number of times the tool can be used in the API request.
39093895
3910 exclusiveMinimum: 0
3896 minimum: 1
39113897
39123898 - `strict: optional boolean`
39133899
from line 3901
39153901
39163902 - `url_sources: optional BetaWebFetchURLSources or null`
39173903
3918 Which sources contribute to the set of URLs web fetch may fetch.
3904 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
39193905
3920 Each key is a tagged variant: `user_input` is `all` or `none`; the
3921 two tool filters are `all`, `none`, `only` (only the named tools'
3922 results) or `except` (every result but the named tools'). A named tool
3923 must be declared in this request's `tools[]`.
3924
39253906 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
39263907
39273908 Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
from line 4025
40444025
40454026 Maximum number of times the tool can be used in the API request.
40464027
4047 exclusiveMinimum: 0
4028 minimum: 1
40484029
40494030 - `strict: optional boolean`
40504031
from line 4079
40984079
40994080 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.
41004081
4101 exclusiveMinimum: 0
4082 minimum: 1
41024083
41034084 - `max_uses: optional number or null`
41044085
41054086 Maximum number of times the tool can be used in the API request.
41064087
4107 exclusiveMinimum: 0
4088 minimum: 1
41084089
41094090 - `strict: optional boolean`
41104091
from line 4093
41124093
41134094 - `url_sources: optional BetaWebFetchURLSources or null`
41144095
4115 Which sources contribute to the set of URLs web fetch may fetch.
4096 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
41164097
4117 Each key is a tagged variant: `user_input` is `all` or `none`; the
4118 two tool filters are `all`, `none`, `only` (only the named tools'
4119 results) or `except` (every result but the named tools'). A named tool
4120 must be declared in this request's `tools[]`.
4121
41224098 - `BetaWebFetchTool20260309 object`
41234099
41244100 Web fetch tool with use_cache parameter for bypassing cached content.
from line 4141
41654141
41664142 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.
41674143
4168 exclusiveMinimum: 0
4144 minimum: 1
41694145
41704146 - `max_uses: optional number or null`
41714147
41724148 Maximum number of times the tool can be used in the API request.
41734149
4174 exclusiveMinimum: 0
4150 minimum: 1
41754151
41764152 - `strict: optional boolean`
41774153
from line 4155
41794155
41804156 - `url_sources: optional BetaWebFetchURLSources or null`
41814157
4182 Which sources contribute to the set of URLs web fetch may fetch.
4158 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
41834159
4184 Each key is a tagged variant: `user_input` is `all` or `none`; the
4185 two tool filters are `all`, `none`, `only` (only the named tools'
4186 results) or `except` (every result but the named tools'). A named tool
4187 must be declared in this request's `tools[]`.
4188
41894160 - `use_cache: optional boolean`
41904161
41914162 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 4201
42304201
42314202 Maximum number of times the tool can be used in the API request.
42324203
4233 exclusiveMinimum: 0
4204 minimum: 1
42344205
42354206 - `response_inclusion: optional "full" or "excluded"`
42364207
from line 4263
42924263
42934264 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.
42944265
4295 exclusiveMinimum: 0
4266 minimum: 1
42964267
42974268 - `max_uses: optional number or null`
42984269
42994270 Maximum number of times the tool can be used in the API request.
43004271
4301 exclusiveMinimum: 0
4272 minimum: 1
43024273
43034274 - `response_inclusion: optional "full" or "excluded"`
43044275
from line 4285
43144285
43154286 - `url_sources: optional BetaWebFetchURLSources or null`
43164287
4317 Which sources contribute to the set of URLs web fetch may fetch.
4288 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
43184289
4319 Each key is a tagged variant: `user_input` is `all` or `none`; the
4320 two tool filters are `all`, `none`, `only` (only the named tools'
4321 results) or `except` (every result but the named tools'). A named tool
4322 must be declared in this request's `tools[]`.
4323
43244290 - `use_cache: optional boolean`
43254291
43264292 Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources.
from line 4301
43354301
43364302 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
43374303
4304 - `string`
4305
43384306 - `"claude-fable-5-1" or "claude-opus-5-5" or "claude-mythos-5-1" or 15 more`
43394307
43404308 The model that will complete your prompt.
from line 4345
43774345
43784346 Powerful intelligence for long-running agents and coding
43794347
4380 - `"claude-mythos-preview"`
4381
4382 New class of intelligence, strongest in coding and cybersecurity
4383
43844348 - `"claude-opus-4-6"`
43854349
43864350 Powerful intelligence for long-running agents and coding
from line 4377
44134377
44144378 High-performance model for agents and coding
44154379
4416 - `string`
4380 - `"claude-mythos-preview"`
44174381
4382 **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information.
4383
4384 New class of intelligence, strongest in coding and cybersecurity
4385
44184386 - `name: "advisor"`
44194387
44204388 Name of the tool.
from line 4421
44534421
44544422 Maximum number of times the tool can be used in the API request.
44554423
4456 exclusiveMinimum: 0
4424 minimum: 1
44574425
44584426 - `strict: optional boolean`
44594427
from line 4512
45444512
45454513 Name of the MCP server to configure tools for
45464514
4547 maxLength: 255, minLength: 1
4515 minLength: 1, maxLength: 255
45484516
45494517 - `cache_control: optional BetaCacheControlEphemeral or null`
45504518
from line 4622
46544622
46554623 The name of the MCP server this listing came from, as `mcp_servers` declares it.
46564624
4657 maxLength: 255, minLength: 1
4625 minLength: 1, maxLength: 255
46584626
46594627 - `tools: array of BetaMCPToolParam`
46604628
from line 4704
47364704
47374705 - `effort: optional "low" or "medium" or "high" or 2 more or null`
47384706
4739 All possible effort levels.
4707 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
47404708
4709 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
4710
47414711 - `"low"`
47424712
47434713 - `"medium"`
from line 4730
47604730
47614731- `compaction: optional BetaCompactionConfig or null`
47624732
4763 Compact the whole conversation and return a signed `compaction` block,
4764 alone, that a later request sends back first in `messages`, in place of
4765 the messages it summarizes. There is no trigger and no pause flag: sending
4766 the parameter compacts, and nothing is sampled after the block.
4733 Compaction configuration.
47674734
4768 The summarization prompt is the server's own unless `instructions` are
4769 given, which then replace it for this request; a value that is empty or
4770 only whitespace counts as absent.
4735 When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`.
47714736
47724737 - `type: "summarize"`
47734738
from line 4772
48074772
48084773 Skill ID
48094774
4810 maxLength: 64, minLength: 1
4775 minLength: 1, maxLength: 64
48114776
48124777 - `version: optional string`
48134778
48144779 Skill version or 'latest' for most recent version
48154780
4816 maxLength: 64, minLength: 1
4781 minLength: 1, maxLength: 64
48174782
48184783 - `string`
48194784
from line 4792
48274792
48284793 List of context management edits to apply
48294794
4830 minItems: 0
4831
48324795 - `BetaClearToolUses20250919Edit object`
48334796
48344797 - `type: "clear_tool_uses_20250919"`
from line 4890
49274890
49284891- `diagnostics: optional BetaDiagnosticsParam or null`
49294892
4930 Request-level diagnostics. Currently carries the previous response
4931 id for prompt-cache divergence reporting.
4893 Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request.
49324894
49334895 - `previous_message_id: optional string or null`
49344896
from line 4937
49754937
49764938 The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries.
49774939
4978 maxLength: 2048, minLength: 1
4940 minLength: 1, maxLength: 2048
49794941
49804942 - `mode: optional "strict" or "best_effort"`
49814943
from line 4965
50034965
50044966 - `effort: optional "low" or "medium" or "high" or 2 more or null`
50054967
5006 All possible effort levels.
4968 How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
50074969
4970 Valid values are `low`, `medium`, `high`, `xhigh`, or `max`.
4971
50084972 - `"low"`
50094973
50104974 - `"medium"`
from line 4991
50274991
50284992 - `task_budget: optional BetaTokenTaskBudget or null`
50294993
5030 User-configurable total token budget across contexts.
4994 Configuration for token budget tracking across contexts.
50314995
50324996 - `type: "tokens"`
50334997
from line 5035
50715035
50725036 - `block_binding: optional BetaThinkingBlockBinding or null`
50735037
5074 Controls for block binding: what happens when a thinking block this
5075 request sends back fails the conversation check. Every field is optional;
5076 an empty object means every default.
5038 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
50775039
50785040 - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null`
50795041
5080 What happens when a thinking block in `messages` fails the conversation
5081 check: it was created in a different conversation, or the messages before
5082 it have changed since. `"error"` (the default) fails the request with a
5083 400 error. `"drop_block"` removes the failing blocks and the request
5084 proceeds; the model no longer sees the dropped reasoning.
5042 "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`.
50855043
50865044 - `"error"`
50875045
from line 5065
51075065
51085066 - `block_binding: optional BetaThinkingBlockBinding or null`
51095067
5110 Controls for block binding: what happens when a thinking block this
5111 request sends back fails the conversation check. Every field is optional;
5112 an empty object means every default.
5068 Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default.
51135069
51145070 - `display: optional "summarized" or "omitted" or "updates" or null`
51155071
from line 5131
51755131
51765132- `speed: optional "standard" or "fast" or null`
51775133
5178 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
5134 The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference.
51795135
51805136 - `"standard"`
51815137
from line 5400
54445400
54455401 Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
54465402
5447 maximum: 1, minimum: 0
5403 minimum: 0, maximum: 1
54485404
54495405- `top_k: optional number`
54505406
from line 5424
54685424
54695425 Recommended for advanced use cases only.
54705426
5471 maximum: 1, minimum: 0
5427 minimum: 0, maximum: 1
54725428
54735429#### Returns
54745430
from line 5446
54905446
54915447 - `container: BetaContainer or null`
54925448
5493 Information about the container used in the request (for the code execution tool)
5449 Information about the container used in this request.
54945450
5451 This will be non-null if a container tool (e.g. code execution) was used.
5452
54955453 - `id: string`
54965454
54975455 Identifier for the container used in this request
from line 5476
55185476
55195477 Skill ID
55205478
5521 maxLength: 64, minLength: 1
5479 minLength: 1, maxLength: 64
55225480
55235481 - `version: string`
55245482
55255483 The resolved version: a skill version ID for custom skills.
55265484
5527 maxLength: 64, minLength: 1
5485 minLength: 1, maxLength: 64
55285486
55295487 - `content: array of BetaContentBlock`
55305488
from line 5655
56975655
56985656 - `text: string`
56995657
5700 minLength: 0
5701
57025658 - `BetaThinkingBlock object`
57035659
57045660 - `type: "thinking"`
from line 5733
57775733
57785734 For a toolset member tool_use, the toolset family.
57795735
5780 maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$
5736 minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$
57815737
57825738 - `BetaServerToolUseBlock object`
57835739
from line 6237
62816237
62826238 - `tool_name: string`
62836239
6284 maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$
6240 minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$
62856241
62866242 - `tool_use_id: string`
62876243
from line 6287
63316287
63326288 - `text: string`
63336289
6334 minLength: 0
6335
63366290 - `is_error: boolean`
63376291
63386292 default: false
from line 6424
64706424
64716425 This is how the tool will be called by the model and in `tool_use` blocks.
64726426
6473 maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$
6427 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$
64746428
64756429 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
64766430
from line 6688
67346688
67356689 - `configs: optional BetaBrowserToolsetConfigs or null`
67366690
6737 Per-member configuration for `browser_toolset_20260801`: one
6738 optional field per member tool, keyed by the member name — the same
6739 name the member's `tool_use` blocks carry. Every member is an
6740 accepted key, and a member's defaults apply wherever its key is
6741 absent. Unknown keys are rejected: the field set is this toolset
6742 version's complete member set.
6691 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
67436692
67446693 - `type: optional BetaBrowserTypeConfig or null`
67456694
from line 7309
73607309
73617310 - `configs: optional BetaComputerToolsetConfigs or null`
73627311
7363 Per-member configuration for `computer_toolset_20260801`: one
7364 optional field per member tool, keyed by the member name — the same
7365 name the member's `tool_use` blocks carry. Every member is an
7366 accepted key, and a member's defaults apply wherever its key is
7367 absent. Unknown keys are rejected: the field set is this toolset
7368 version's complete member set.
7312 Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
73697313
73707314 - `type: optional BetaComputerTypeConfig or null`
73717315
from line 7663
77197663
77207664 Maximum number of times the tool can be used in the API request.
77217665
7722 exclusiveMinimum: 0
7666 minimum: 1
77237667
77247668 - `strict: optional boolean`
77257669
from line 7679
77357679
77367680 The city of the user.
77377681
7738 maxLength: 255, minLength: 1
7682 minLength: 1, maxLength: 255
77397683
77407684 - `country: optional string or null`
77417685
77427686 The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user.
77437687
7744 maxLength: 2, minLength: 2
7688 minLength: 2, maxLength: 2
77457689
77467690 - `region: optional string or null`
77477691
77487692 The region of the user.
77497693
7750 maxLength: 255, minLength: 1
7694 minLength: 1, maxLength: 255
77517695
77527696 - `timezone: optional string or null`
77537697
77547698 The [IANA timezone](https://nodatime.org/TimeZones) of the user.
77557699
7756 maxLength: 255, minLength: 1
7700 minLength: 1, maxLength: 255
77577701
77587702 - `BetaWebFetchTool20250910 object`
77597703
from line 7713
77697713
77707714 - `"direct"`
77717715
7772
7716 - `"code_execution_20250825"`
7717
7718 - `"code_execution_20260120"`
7719
7720 - `"code_execution_20260521"`
7721
7722 - `allowed_domains: optional array of string or null`
7723
7724 List of domains to allow fetching from
7725
7726 - `blocked_domains: optional array of string or null`
7727
7728 List of domains to block fetching from
7729
7730 - `cache_control: optional BetaCacheControlEphemeral or null`
7731
7732 Create a cache control breakpoint at this content block.
7733
7734 - `citations: optional BetaCitationsConfigParam or null`
7735
7736 Citations configuration for fetched documents. Citations are disabled by default.
7737
7738 - `enabled: optional boolean`
7739
7740 - `defer_loading: optional boolean`
7741
7742 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
7743
7744 - `max_content_tokens: optional number or null`
7745
7746 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.
7747
7748 minimum: 1
7749
7750 - `max_uses: optional number or null`
7751
7752 Maximum number of times the tool can be used in the API request.
7753
7754 minimum: 1
7755
7756 - `strict: optional boolean`
7757
7758 When true, guarantees schema validation on tool names and inputs
7759
7760 - `url_sources: optional BetaWebFetchURLSources or null`
7761
7762 Which sources contribute to the set of URLs the tool may fetch. Omitted means every source.
7763
7764 - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept`
7765
7766 Which client tools' results contribute fetchable URLs: "all"
api/beta/agents Changed · +4321 / -4303 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 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control
131131
132 - `BetaManagedAgentsModel = "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more or string`
132 - `BetaManagedAgentsModel = string or "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
133133
134134 The model that will power your agent.
135135
136136 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
137137
138 - `string`
139
138140 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
139141
140142 The model that will power your agent.
from line 203
201203
202204 High-performance model for agents and coding
203205
204 - `string`
205
206206 - `BetaManagedAgentsModelConfigParams object`
207207
208208 An object that defines additional configuration control over model use
from line 277
277277
278278 - `speed: optional "standard" or "fast" or null`
279279
280 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
280 Inference speed mode. Defaults to `standard`.
281281
282282 - `"standard"`
283283
from line 319
319319
320320- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
321321
322 A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
322 Multiagent orchestration configuration. Currently supports the `coordinator` topology with a roster of 1-20 agents.
323323
324324 - `type: "coordinator"`
325325
from line 441
441441
442442 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
443443
444 Permission policy for tool execution.
444 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
445445
446446 - `BetaManagedAgentsAlwaysAllowPolicy object`
447447
from line 477
477477
478478 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
479479
480 Permission policy for tool execution.
480 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
481481
482482 - `BetaManagedAgentsAlwaysAllowPolicy object`
483483
from line 507
507507
508508 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
509509
510 Permission policy for tool execution.
510 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
511511
512512 - `BetaManagedAgentsAlwaysAllowPolicy object`
513513
from line 537
537537
538538 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
539539
540 Permission policy for tool execution.
540 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
541541
542542 - `BetaManagedAgentsAlwaysAllowPolicy object`
543543
from line 567
567567
568568 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
569569
570 Permission policy for tool execution.
570 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
571571
572572 - `BetaManagedAgentsAlwaysAllowPolicy object`
573573
from line 597
597597
598598 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
599599
600 Permission policy for tool execution.
600 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
601601
602602 - `BetaManagedAgentsAlwaysAllowPolicy object`
603603
from line 641
641641
642642 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
643643
644 Permission policy for tool execution.
644 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
645645
646646 - `BetaManagedAgentsAlwaysAllowPolicy object`
647647
from line 679
679679
680680 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
681681
682 Permission policy for tool execution.
682 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
683683
684684 - `BetaManagedAgentsAlwaysAllowPolicy object`
685685
from line 725
725725
726726 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
727727
728 Default configuration for all tools in a toolset.
728 Default configuration applied to all tools in this set.
729729
730730 - `enabled: optional boolean or null`
731731
from line 733
733733
734734 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
735735
736 Permission policy for tool execution.
736 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
737737
738738 - `BetaManagedAgentsAlwaysAllowPolicy object`
739739
from line 775
775775
776776 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
777777
778 Permission policy for tool execution.
778 Permission policy for this tool. Overrides the `default_config` setting.
779779
780780 - `BetaManagedAgentsAlwaysAllowPolicy object`
781781
from line 791
791791
792792 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
793793
794 Default configuration for all tools from an MCP server.
794 Default configuration for all tools from this server.
795795
796796 - `enabled: optional boolean or null`
797797
from line 799
799799
800800 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
801801
802 Permission policy for tool execution.
802 Default permission policy for tools from this server.
803803
804804 - `BetaManagedAgentsAlwaysAllowPolicy object`
805805
from line 827
827827
828828 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
829829
830 JSON Schema for custom tool input parameters.
830 JSON Schema defining the expected input parameters for the tool.
831831
832832 - `type: "object"`
833833
from line 853
853853
854854 - `archived_at: string or null`
855855
856 A timestamp in RFC 3339 format
856 When the agent was archived. Null if not archived.
857857
858858 format: date-time
859859
from line 885
885885
886886 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
887887
888 - `string`
889
888890 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
889891
890892 The model that will power your agent.
from line 953
951953
952954 High-performance model for agents and coding
953955
954 - `string`
955
956956 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
957957
958 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
958 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
959959
960960 - `BetaManagedAgentsEffortLow object`
961961
from line 993
993993
994994 - `speed: optional "standard" or "fast"`
995995
996 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
996 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
997997
998998 - `"standard"`
999999
from line 1001
10011001
10021002 - `multiagent: BetaManagedAgentsMultiagent or null`
10031003
1004 Resolved coordinator topology with a concrete agent roster.
1004 Multiagent orchestration configuration. Null when the agent is single-threaded.
10051005
10061006 - `type: "coordinator"`
10071007
from line 1440
14401440 "metadata": {
14411441 "foo": "bar"
14421442 },
1443 "multiagent": {
1444 "agents": [
1445 "agent_011CZkYqphY8vELVzwCUpqiQ",
1446 {
1447 "type": "self"
1448 }
1449 ],
1450 "type": "coordinator"
1451 },
14431452 "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.",
14441453 "tools": [
14451454 {
from line 1693
16841693
16851694 - `archived_at: string or null`
16861695
1687 A timestamp in RFC 3339 format
1696 When the agent was archived. Null if not archived.
16881697
16891698 format: date-time
16901699
from line 1725
17161725
17171726 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
17181727
1728 - `string`
1729
17191730 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
17201731
17211732 The model that will power your agent.
from line 1793
17821793
17831794 High-performance model for agents and coding
17841795
1785 - `string`
1786
17871796 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
17881797
1789 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
1798 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
17901799
17911800 - `BetaManagedAgentsEffortLow object`
17921801
from line 1833
18241833
18251834 - `speed: optional "standard" or "fast"`
18261835
1827 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
1836 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
18281837
18291838 - `"standard"`
18301839
from line 1841
18321841
18331842 - `multiagent: BetaManagedAgentsMultiagent or null`
18341843
1835 Resolved coordinator topology with a concrete agent roster.
1844 Multiagent orchestration configuration. Null when the agent is single-threaded.
18361845
18371846 - `type: "coordinator"`
18381847
from line 2504
24952504
24962505 - `archived_at: string or null`
24972506
2498 A timestamp in RFC 3339 format
2507 When the agent was archived. Null if not archived.
24992508
25002509 format: date-time
25012510
from line 2536
25272536
25282537 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
25292538
2539 - `string`
2540
25302541 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
25312542
25322543 The model that will power your agent.
from line 2604
25932604
25942605 High-performance model for agents and coding
25952606
2596 - `string`
2597
25982607 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
25992608
2600 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
2609 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
26012610
26022611 - `BetaManagedAgentsEffortLow object`
26032612
from line 2644
26352644
26362645 - `speed: optional "standard" or "fast"`
26372646
2638 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
2647 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
26392648
26402649 - `"standard"`
26412650
from line 2652
26432652
26442653 - `multiagent: BetaManagedAgentsMultiagent or null`
26452654
2646 Resolved coordinator topology with a concrete agent roster.
2655 Multiagent orchestration configuration. Null when the agent is single-threaded.
26472656
26482657 - `type: "coordinator"`
26492658
from line 3320
33113320
33123321 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
33133322
3314 - `BetaManagedAgentsModel = "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more or string`
3323 - `BetaManagedAgentsModel = string or "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
33153324
33163325 The model that will power your agent.
33173326
33183327 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
33193328
3329 - `string`
3330
33203331 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
33213332
33223333 The model that will power your agent.
from line 3394
33833394
33843395 High-performance model for agents and coding
33853396
3386 - `string`
3387
33883397 - `BetaManagedAgentsModelConfigParams object`
33893398
33903399 An object that defines additional configuration control over model use
from line 3468
34593468
34603469 - `speed: optional "standard" or "fast" or null`
34613470
3462 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
3471 Inference speed mode. Defaults to `standard`.
34633472
34643473 - `"standard"`
34653474
from line 3476
34673476
34683477- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
34693478
3470 A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
3479 Multiagent orchestration configuration. Full replacement. Omit to preserve; send null to clear.
34713480
34723481 - `type: "coordinator"`
34733482
from line 3604
35953604
35963605 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
35973606
3598 Permission policy for tool execution.
3607 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
35993608
36003609 - `BetaManagedAgentsAlwaysAllowPolicy object`
36013610
from line 3640
36313640
36323641 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
36333642
3634 Permission policy for tool execution.
3643 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
36353644
36363645 - `BetaManagedAgentsAlwaysAllowPolicy object`
36373646
from line 3670
36613670
36623671 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
36633672
3664 Permission policy for tool execution.
3673 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
36653674
36663675 - `BetaManagedAgentsAlwaysAllowPolicy object`
36673676
from line 3700
36913700
36923701 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
36933702
3694 Permission policy for tool execution.
3703 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
36953704
36963705 - `BetaManagedAgentsAlwaysAllowPolicy object`
36973706
from line 3730
37213730
37223731 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
37233732
3724 Permission policy for tool execution.
3733 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
37253734
37263735 - `BetaManagedAgentsAlwaysAllowPolicy object`
37273736
from line 3760
37513760
37523761 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
37533762
3754 Permission policy for tool execution.
3763 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
37553764
37563765 - `BetaManagedAgentsAlwaysAllowPolicy object`
37573766
from line 3804
37953804
37963805 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
37973806
3798 Permission policy for tool execution.
3807 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
37993808
38003809 - `BetaManagedAgentsAlwaysAllowPolicy object`
38013810
from line 3842
38333842
38343843 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
38353844
3836 Permission policy for tool execution.
3845 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
38373846
38383847 - `BetaManagedAgentsAlwaysAllowPolicy object`
38393848
from line 3888
38793888
38803889 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
38813890
3882 Default configuration for all tools in a toolset.
3891 Default configuration applied to all tools in this set.
38833892
38843893 - `enabled: optional boolean or null`
38853894
from line 3896
38873896
38883897 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
38893898
3890 Permission policy for tool execution.
3899 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
38913900
38923901 - `BetaManagedAgentsAlwaysAllowPolicy object`
38933902
from line 3938
39293938
39303939 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
39313940
3932 Permission policy for tool execution.
3941 Permission policy for this tool. Overrides the `default_config` setting.
39333942
39343943 - `BetaManagedAgentsAlwaysAllowPolicy object`
39353944
from line 3954
39453954
39463955 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
39473956
3948 Default configuration for all tools from an MCP server.
3957 Default configuration for all tools from this server.
39493958
39503959 - `enabled: optional boolean or null`
39513960
from line 3962
39533962
39543963 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
39553964
3956 Permission policy for tool execution.
3965 Default permission policy for tools from this server.
39573966
39583967 - `BetaManagedAgentsAlwaysAllowPolicy object`
39593968
from line 3990
39813990
39823991 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
39833992
3984 JSON Schema for custom tool input parameters.
3993 JSON Schema defining the expected input parameters for the tool.
39853994
39863995 - `type: "object"`
39873996
from line 4022
40134022
40144023 - `archived_at: string or null`
40154024
4016 A timestamp in RFC 3339 format
4025 When the agent was archived. Null if not archived.
40174026
40184027 format: date-time
40194028
from line 4054
40454054
40464055 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
40474056
4057 - `string`
4058
40484059 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
40494060
40504061 The model that will power your agent.
from line 4122
41114122
41124123 High-performance model for agents and coding
41134124
4114 - `string`
4115
41164125 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
41174126
4118 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
4127 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
41194128
41204129 - `BetaManagedAgentsEffortLow object`
41214130
from line 4162
41534162
41544163 - `speed: optional "standard" or "fast"`
41554164
4156 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
4165 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
41574166
41584167 - `"standard"`
41594168
from line 4170
41614170
41624171 - `multiagent: BetaManagedAgentsMultiagent or null`
41634172
4164 Resolved coordinator topology with a concrete agent roster.
4173 Multiagent orchestration configuration. Null when the agent is single-threaded.
41654174
41664175 - `type: "coordinator"`
41674176
from line 4604
45954604 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
45964605 -d '{
45974606 "description": "updated",
4607 "multiagent": {
4608 "agents": [
4609 "agent_011CZkYqphY8vELVzwCUpqiQ",
4610 {
4611 "type": "self"
4612 }
4613 ],
4614 "type": "coordinator"
4615 },
45984616 "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.",
45994617 "version": 1
46004618 }'
from line 4831
48134831
48144832 - `archived_at: string or null`
48154833
4816 A timestamp in RFC 3339 format
4834 When the agent was archived. Null if not archived.
48174835
48184836 format: date-time
48194837
from line 4863
48454863
48464864 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
48474865
4866 - `string`
4867
48484868 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
48494869
48504870 The model that will power your agent.
from line 4931
49114931
49124932 High-performance model for agents and coding
49134933
4914 - `string`
4915
49164934 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
49174935
4918 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
4936 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
49194937
49204938 - `BetaManagedAgentsEffortLow object`
49214939
from line 4971
49534971
49544972 - `speed: optional "standard" or "fast"`
49554973
4956 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
4974 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
49574975
49584976 - `"standard"`
49594977
from line 4979
49614979
49624980 - `multiagent: BetaManagedAgentsMultiagent or null`
49634981
4964 Resolved coordinator topology with a concrete agent roster.
4982 Multiagent orchestration configuration. Null when the agent is single-threaded.
49654983
49664984 - `type: "coordinator"`
49674985
from line 5516
54985516
54995517 - `archived_at: string or null`
55005518
5501 A timestamp in RFC 3339 format
5519 When the agent was archived. Null if not archived.
55025520
55035521 format: date-time
55045522
from line 5548
55305548
55315549 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
55325550
5551 - `string`
5552
55335553 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
55345554
55355555 The model that will power your agent.
from line 5616
55965616
55975617 High-performance model for agents and coding
55985618
5599 - `string`
5600
56015619 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
56025620
5603 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
5621 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
56045622
56055623 - `BetaManagedAgentsEffortLow object`
56065624
from line 5656
56385656
56395657 - `speed: optional "standard" or "fast"`
56405658
5641 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
5659 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
56425660
56435661 - `"standard"`
56445662
from line 5664
56465664
56475665 - `multiagent: BetaManagedAgentsMultiagent or null`
56485666
5649 Resolved coordinator topology with a concrete agent roster.
5667 Multiagent orchestration configuration. Null when the agent is single-threaded.
56505668
56515669 - `type: "coordinator"`
56525670
from line 6386
63686386
63696387 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
63706388
6371 Permission policy for tool execution.
6389 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
63726390
63736391 - `BetaManagedAgentsAlwaysAllowPolicy object`
63746392
from line 6422
64046422
64056423 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
64066424
6407 Permission policy for tool execution.
6425 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
64086426
64096427 - `BetaManagedAgentsAlwaysAllowPolicy object`
64106428
from line 6452
64346452
64356453 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
64366454
6437 Permission policy for tool execution.
6455 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
64386456
64396457 - `BetaManagedAgentsAlwaysAllowPolicy object`
64406458
from line 6482
64646482
64656483 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
64666484
6467 Permission policy for tool execution.
6485 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
64686486
64696487 - `BetaManagedAgentsAlwaysAllowPolicy object`
64706488
from line 6512
64946512
64956513 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
64966514
6497 Permission policy for tool execution.
6515 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
64986516
64996517 - `BetaManagedAgentsAlwaysAllowPolicy object`
65006518
from line 6542
65246542
65256543 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
65266544
6527 Permission policy for tool execution.
6545 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
65286546
65296547 - `BetaManagedAgentsAlwaysAllowPolicy object`
65306548
from line 6586
65686586
65696587 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
65706588
6571 Permission policy for tool execution.
6589 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
65726590
65736591 - `BetaManagedAgentsAlwaysAllowPolicy object`
65746592
from line 6624
66066624
66076625 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
66086626
6609 Permission policy for tool execution.
6627 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
66106628
66116629 - `BetaManagedAgentsAlwaysAllowPolicy object`
66126630
from line 6710
66926710
66936711 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
66946712
6695 Permission policy for tool execution.
6713 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
66966714
66976715 - `BetaManagedAgentsAlwaysAllowPolicy object`
66986716
from line 7129
71117129
71127130 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
71137131
7114 Permission policy for tool execution.
7132 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
71157133
71167134 - `BetaManagedAgentsAlwaysAllowPolicy object`
71177135
from line 7165
71477165
71487166 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
71497167
7150 Permission policy for tool execution.
7168 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
71517169
71527170 - `BetaManagedAgentsAlwaysAllowPolicy object`
71537171
from line 7195
71777195
71787196 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
71797197
7180 Permission policy for tool execution.
7198 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
71817199
71827200 - `BetaManagedAgentsAlwaysAllowPolicy object`
71837201
from line 7225
72077225
72087226 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
72097227
7210 Permission policy for tool execution.
7228 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
72117229
72127230 - `BetaManagedAgentsAlwaysAllowPolicy object`
72137231
from line 7255
72377255
72387256 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
72397257
7240 Permission policy for tool execution.
7258 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
72417259
72427260 - `BetaManagedAgentsAlwaysAllowPolicy object`
72437261
from line 7285
72677285
72687286 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
72697287
7270 Permission policy for tool execution.
7288 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
72717289
72727290 - `BetaManagedAgentsAlwaysAllowPolicy object`
72737291
from line 7329
73117329
73127330 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
73137331
7314 Permission policy for tool execution.
7332 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
73157333
73167334 - `BetaManagedAgentsAlwaysAllowPolicy object`
73177335
from line 7367
73497367
73507368 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
73517369
7352 Permission policy for tool execution.
7370 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
73537371
73547372 - `BetaManagedAgentsAlwaysAllowPolicy object`
73557373
from line 7413
73957413
73967414 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
73977415
7398 Default configuration for all tools in a toolset.
7416 Default configuration applied to all tools in this set.
73997417
74007418 - `enabled: optional boolean or null`
74017419
from line 7421
74037421
74047422 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
74057423
7406 Permission policy for tool execution.
7424 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
74077425
74087426 - `BetaManagedAgentsAlwaysAllowPolicy object`
74097427
from line 7578
75607578
75617579 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
75627580
7563 Permission policy for tool execution.
7581 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
75647582
75657583 - `BetaManagedAgentsAlwaysAllowPolicy object`
75667584
from line 7680
76627680
76637681 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
76647682
7665 JSON Schema for custom tool input parameters.
7683 JSON Schema defining the expected input parameters for the tool.
76667684
76677685 - `type: "object"`
76687686
from line 7746
77287746
77297747 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
77307748
7731 Permission policy for tool execution.
7749 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
77327750
77337751 - `BetaManagedAgentsAlwaysAllowPolicy object`
77347752
from line 7858
78407858
78417859 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
78427860
7843 Permission policy for tool execution.
7861 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
78447862
78457863 - `BetaManagedAgentsAlwaysAllowPolicy object`
78467864
from line 7930
79127930
79137931 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
79147932
7915 Permission policy for tool execution.
7933 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
79167934
79177935 - `BetaManagedAgentsAlwaysAllowPolicy object`
79187936
from line 8012
79948012
79958013 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
79968014
7997 Permission policy for tool execution.
8015 Permission policy for this tool. Overrides the `default_config` setting.
79988016
79998017 - `BetaManagedAgentsAlwaysAllowPolicy object`
80008018
from line 8132
81148132
81158133 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
81168134
8117 Permission policy for tool execution.
8135 Default permission policy for tools from this server.
81188136
81198137 - `BetaManagedAgentsAlwaysAllowPolicy object`
81208138
from line 8182
81648182
81658183 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
81668184
8167 Permission policy for tool execution.
8185 Permission policy for this tool. Overrides the `default_config` setting.
81688186
81698187 - `BetaManagedAgentsAlwaysAllowPolicy object`
81708188
from line 8204
81868204
81878205 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
81888206
8189 Default configuration for all tools from an MCP server.
8207 Default configuration for all tools from this server.
81908208
81918209 - `enabled: optional boolean or null`
81928210
from line 8212
81948212
81958213 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
81968214
8197 Permission policy for tool execution.
8215 Default permission policy for tools from this server.
81988216
81998217 - `BetaManagedAgentsAlwaysAllowPolicy object`
82008218
82018219 Tool calls are automatically approved without user confirmation.
82028220
8203 - `BetaManagedAgentsAlwaysAskPolicy object`
8204
8205 Tool calls require user confirmation before execution.
8206
8207 - `BetaManagedAgentsAutoPolicy object`
8208
8209 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.
8210
8211### Beta Managed Agents Model
8212
8213- `BetaManagedAgentsModel = "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more or string`
8214
8215 The model that will power your agent.
8216
8217 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
8218
8219 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
8220
8221 The model that will power your agent.
8222
8223 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
8224
8225 - `"claude-opus-5-5"`
8226
8227 Powerful intelligence for coding, knowledge work, and long-running agents
8228
8229 - `"claude-fable-5-1"`
8230
8231 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
8232
8233 - `"claude-sonnet-5"`
8234
8235 High-performance model for coding and agents
8236
8237 - `"claude-fable-5"`
8238
8239 Next generation of intelligence for the hardest knowledge work and coding problems
8240
8241 - `"claude-opus-5"`
8242
8243 Powerful intelligence for long-running agents and coding
8244
8245 - `"claude-opus-4-8"`
8246
8247 Powerful intelligence for long-running agents and coding
8248
8249 - `"claude-opus-4-7"`
8250
8251 Powerful intelligence for long-running agents and coding
8252
8253 - `"claude-opus-4-6"`
8254
8255 Powerful intelligence for long-running agents and coding
8256
8257 - `"claude-sonnet-4-6"`
8258
8259 Best combination of speed and intelligence
8260
8261 - `"claude-haiku-4-5"`
8262
8263 Fastest model with near-frontier intelligence
8264
8265 - `"claude-haiku-4-5-20251001"`
8266
8267 Fastest model with near-frontier intelligence
8268
8269 - `"claude-opus-4-5"`
8270
8271 Powerful intelligence for long-running agents and coding
8272
8273 - `"claude-opus-4-5-20251101"`
8274
8275 Powerful intelligence for long-running agents and coding
8276
8277 - `"claude-sonnet-4-5"`
8278
8279 High-performance model for agents and coding
8280
8281 - `"claude-sonnet-4-5-20250929"`
8282
8283 High-performance model for agents and coding
8284
8285 - `string`
8286
8287### Beta Managed Agents Model Config
8288
8289- `BetaManagedAgentsModelConfig object`
8290
8291 Model identifier and configuration.
8292
8293 - `id: BetaManagedAgentsModel`
8294
8295 The model that will power your agent.
8296
8297 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
8298
8299 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
8300
8301 The model that will power your agent.
8302
8303 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
8304
8305 - `"claude-opus-5-5"`
8306
8307 Powerful intelligence for coding, knowledge work, and long-running agents
8308
8309 - `"claude-fable-5-1"`
8310
8311 Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
8312
8313 - `"claude-sonnet-5"`
8314
8315 High-performance model for coding and agents
8316
8317 - `"claude-fable-5"`
8318
8319 Next generation of intelligence for the hardest knowledge work and coding problems
8320
8321 - `"claude-opus-5"`
8322
8323 Powerful intelligence for long-running agents and coding
8324
8325 - `"claude-opus-4-8"`
8326
8327 Powerful intelligence for long-running agents and coding
8328
8329 - `"claude-opus-4-7"`
8330
8331 Powerful intelligence for long-running agents and coding
8332
8333 - `"claude-opus-4-6"`
8334
8335 Powerful intelligence for long-running agents and coding
8336
8337 - `"claude-sonnet-4-6"`
8338
8339 Best combinati
8221 - `BetaManagedAgentsAlwaysAskPolicy
api/beta/agents/archive Changed · +11 / -11 lines
from line 139
139139
140140 - `archived_at: string or null`
141141
142 A timestamp in RFC 3339 format
142 When the agent was archived. Null if not archived.
143143
144144 format: date-time
145145
from line 171
171171
172172 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
173173
174 - `string`
175
174176 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
175177
176178 The model that will power your agent.
from line 239
237239
238240 High-performance model for agents and coding
239241
240 - `string`
241
242242 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
243243
244 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
244 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
245245
246246 - `BetaManagedAgentsEffortLow object`
247247
from line 279
279279
280280 - `speed: optional "standard" or "fast"`
281281
282 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
282 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
283283
284284 - `"standard"`
285285
from line 287
287287
288288 - `multiagent: BetaManagedAgentsMultiagent or null`
289289
290 Resolved coordinator topology with a concrete agent roster.
290 Multiagent orchestration configuration. Null when the agent is single-threaded.
291291
292292 - `type: "coordinator"`
293293
api/beta/agents/create Changed · +764 / -755 lines
from line 127
127127
128128 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control
129129
130 - `BetaManagedAgentsModel = "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more or string`
130 - `BetaManagedAgentsModel = string or "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
131131
132132 The model that will power your agent.
133133
134134 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
135135
136 - `string`
137
136138 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
137139
138140 The model that will power your agent.
from line 201
199201
200202 High-performance model for agents and coding
201203
202 - `string`
203
204204 - `BetaManagedAgentsModelConfigParams object`
205205
206206 An object that defines additional configuration control over model use
from line 275
275275
276276 - `speed: optional "standard" or "fast" or null`
277277
278 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
278 Inference speed mode. Defaults to `standard`.
279279
280280 - `"standard"`
281281
from line 317
317317
318318- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
319319
320 A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
320 Multiagent orchestration configuration. Currently supports the `coordinator` topology with a roster of 1-20 agents.
321321
322322 - `type: "coordinator"`
323323
from line 439
439439
440440 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
441441
442 Permission policy for tool execution.
442 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
443443
444444 - `BetaManagedAgentsAlwaysAllowPolicy object`
445445
from line 475
475475
476476 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
477477
478 Permission policy for tool execution.
478 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
479479
480480 - `BetaManagedAgentsAlwaysAllowPolicy object`
481481
from line 505
505505
506506 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
507507
508 Permission policy for tool execution.
508 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
509509
510510 - `BetaManagedAgentsAlwaysAllowPolicy object`
511511
from line 535
535535
536536 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
537537
538 Permission policy for tool execution.
538 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
539539
540540 - `BetaManagedAgentsAlwaysAllowPolicy object`
541541
from line 565
565565
566566 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
567567
568 Permission policy for tool execution.
568 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
569569
570570 - `BetaManagedAgentsAlwaysAllowPolicy object`
571571
from line 595
595595
596596 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
597597
598 Permission policy for tool execution.
598 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
599599
600600 - `BetaManagedAgentsAlwaysAllowPolicy object`
601601
from line 639
639639
640640 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
641641
642 Permission policy for tool execution.
642 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
643643
644644 - `BetaManagedAgentsAlwaysAllowPolicy object`
645645
from line 677
677677
678678 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
679679
680 Permission policy for tool execution.
680 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
681681
682682 - `BetaManagedAgentsAlwaysAllowPolicy object`
683683
from line 723
723723
724724 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
725725
726 Default configuration for all tools in a toolset.
726 Default configuration applied to all tools in this set.
727727
728728 - `enabled: optional boolean or null`
729729
from line 731
731731
732732 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
733733
734 Permission policy for tool execution.
734 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
735735
736736 - `BetaManagedAgentsAlwaysAllowPolicy object`
737737
from line 773
773773
774774 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
775775
776 Permission policy for tool execution.
776 Permission policy for this tool. Overrides the `default_config` setting.
777777
778778 - `BetaManagedAgentsAlwaysAllowPolicy object`
779779
from line 789
789789
790790 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
791791
792 Default configuration for all tools from an MCP server.
792 Default configuration for all tools from this server.
793793
794794 - `enabled: optional boolean or null`
795795
from line 797
797797
798798 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
799799
800 Permission policy for tool execution.
800 Default permission policy for tools from this server.
801801
802802 - `BetaManagedAgentsAlwaysAllowPolicy object`
803803
from line 825
825825
826826 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
827827
828 JSON Schema for custom tool input parameters.
828 JSON Schema defining the expected input parameters for the tool.
829829
830830 - `type: "object"`
831831
from line 851
851851
852852 - `archived_at: string or null`
853853
854 A timestamp in RFC 3339 format
854 When the agent was archived. Null if not archived.
855855
856856 format: date-time
857857
from line 883
883883
884884 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
885885
886 - `string`
887
886888 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
887889
888890 The model that will power your agent.
from line 951
949951
950952 High-performance model for agents and coding
951953
952 - `string`
953
954954 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
955955
956 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
956 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
957957
958958 - `BetaManagedAgentsEffortLow object`
959959
from line 991
991991
992992 - `speed: optional "standard" or "fast"`
993993
994 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
994 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
995995
996996 - `"standard"`
997997
from line 999
999999
10001000 - `multiagent: BetaManagedAgentsMultiagent or null`
10011001
1002 Resolved coordinator topology with a concrete agent roster.
1002 Multiagent orchestration configuration. Null when the agent is single-threaded.
10031003
10041004 - `type: "coordinator"`
10051005
from line 1437
14371437 "description": "A general-purpose starter agent.",
14381438 "metadata": {
14391439 "foo": "bar"
1440 },
1441 "multiagent": {
1442 "agents": [
1443 "agent_011CZkYqphY8vELVzwCUpqiQ",
1444 {
1445 "type": "self"
1446 }
1447 ],
1448 "type": "coordinator"
14401449 },
14411450 "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.",
14421451 "tools": [
api/beta/agents/list Changed · +11 / -11 lines
from line 161
161161
162162 - `archived_at: string or null`
163163
164 A timestamp in RFC 3339 format
164 When the agent was archived. Null if not archived.
165165
166166 format: date-time
167167
from line 193
193193
194194 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
195195
196 - `string`
197
196198 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
197199
198200 The model that will power your agent.
from line 261
259261
260262 High-performance model for agents and coding
261263
262 - `string`
263
264264 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
265265
266 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
266 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
267267
268268 - `BetaManagedAgentsEffortLow object`
269269
from line 301
301301
302302 - `speed: optional "standard" or "fast"`
303303
304 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
304 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
305305
306306 - `"standard"`
307307
from line 309
309309
310310 - `multiagent: BetaManagedAgentsMultiagent or null`
311311
312 Resolved coordinator topology with a concrete agent roster.
312 Multiagent orchestration configuration. Null when the agent is single-threaded.
313313
314314 - `type: "coordinator"`
315315
api/beta/agents/retrieve Changed · +11 / -11 lines
from line 147
147147
148148 - `archived_at: string or null`
149149
150 A timestamp in RFC 3339 format
150 When the agent was archived. Null if not archived.
151151
152152 format: date-time
153153
from line 179
179179
180180 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
181181
182 - `string`
183
182184 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
183185
184186 The model that will power your agent.
from line 247
245247
246248 High-performance model for agents and coding
247249
248 - `string`
249
250250 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
251251
252 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
252 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
253253
254254 - `BetaManagedAgentsEffortLow object`
255255
from line 287
287287
288288 - `speed: optional "standard" or "fast"`
289289
290 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
290 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
291291
292292 - `"standard"`
293293
from line 295
295295
296296 - `multiagent: BetaManagedAgentsMultiagent or null`
297297
298 Resolved coordinator topology with a concrete agent roster.
298 Multiagent orchestration configuration. Null when the agent is single-threaded.
299299
300300 - `type: "coordinator"`
301301
api/beta/agents/update Changed · +742 / -733 lines
from line 161
161161
162162 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
163163
164 - `BetaManagedAgentsModel = "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more or string`
164 - `BetaManagedAgentsModel = string or "claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
165165
166166 The model that will power your agent.
167167
168168 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
169169
170 - `string`
171
170172 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
171173
172174 The model that will power your agent.
from line 235
233235
234236 High-performance model for agents and coding
235237
236 - `string`
237
238238 - `BetaManagedAgentsModelConfigParams object`
239239
240240 An object that defines additional configuration control over model use
from line 309
309309
310310 - `speed: optional "standard" or "fast" or null`
311311
312 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
312 Inference speed mode. Defaults to `standard`.
313313
314314 - `"standard"`
315315
from line 317
317317
318318- `multiagent: optional BetaManagedAgentsMultiagentParams or null`
319319
320 A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster.
320 Multiagent orchestration configuration. Full replacement. Omit to preserve; send null to clear.
321321
322322 - `type: "coordinator"`
323323
from line 445
445445
446446 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
447447
448 Permission policy for tool execution.
448 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
449449
450450 - `BetaManagedAgentsAlwaysAllowPolicy object`
451451
from line 481
481481
482482 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
483483
484 Permission policy for tool execution.
484 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
485485
486486 - `BetaManagedAgentsAlwaysAllowPolicy object`
487487
from line 511
511511
512512 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
513513
514 Permission policy for tool execution.
514 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
515515
516516 - `BetaManagedAgentsAlwaysAllowPolicy object`
517517
from line 541
541541
542542 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
543543
544 Permission policy for tool execution.
544 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
545545
546546 - `BetaManagedAgentsAlwaysAllowPolicy object`
547547
from line 571
571571
572572 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
573573
574 Permission policy for tool execution.
574 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
575575
576576 - `BetaManagedAgentsAlwaysAllowPolicy object`
577577
from line 601
601601
602602 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
603603
604 Permission policy for tool execution.
604 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
605605
606606 - `BetaManagedAgentsAlwaysAllowPolicy object`
607607
from line 645
645645
646646 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
647647
648 Permission policy for tool execution.
648 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
649649
650650 - `BetaManagedAgentsAlwaysAllowPolicy object`
651651
from line 683
683683
684684 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
685685
686 Permission policy for tool execution.
686 Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation.
687687
688688 - `BetaManagedAgentsAlwaysAllowPolicy object`
689689
from line 729
729729
730730 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
731731
732 Default configuration for all tools in a toolset.
732 Default configuration applied to all tools in this set.
733733
734734 - `enabled: optional boolean or null`
735735
from line 737
737737
738738 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
739739
740 Permission policy for tool execution.
740 Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation.
741741
742742 - `BetaManagedAgentsAlwaysAllowPolicy object`
743743
from line 779
779779
780780 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
781781
782 Permission policy for tool execution.
782 Permission policy for this tool. Overrides the `default_config` setting.
783783
784784 - `BetaManagedAgentsAlwaysAllowPolicy object`
785785
from line 795
795795
796796 - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null`
797797
798 Default configuration for all tools from an MCP server.
798 Default configuration for all tools from this server.
799799
800800 - `enabled: optional boolean or null`
801801
from line 803
803803
804804 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null`
805805
806 Permission policy for tool execution.
806 Default permission policy for tools from this server.
807807
808808 - `BetaManagedAgentsAlwaysAllowPolicy object`
809809
from line 831
831831
832832 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
833833
834 JSON Schema for custom tool input parameters.
834 JSON Schema defining the expected input parameters for the tool.
835835
836836 - `type: "object"`
837837
from line 863
863863
864864 - `archived_at: string or null`
865865
866 A timestamp in RFC 3339 format
866 When the agent was archived. Null if not archived.
867867
868868 format: date-time
869869
from line 895
895895
896896 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
897897
898 - `string`
899
898900 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
899901
900902 The model that will power your agent.
from line 963
961963
962964 High-performance model for agents and coding
963965
964 - `string`
965
966966 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
967967
968 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
968 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
969969
970970 - `BetaManagedAgentsEffortLow object`
971971
from line 1003
10031003
10041004 - `speed: optional "standard" or "fast"`
10051005
1006 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
1006 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
10071007
10081008 - `"standard"`
10091009
from line 1011
10111011
10121012 - `multiagent: BetaManagedAgentsMultiagent or null`
10131013
1014 Resolved coordinator topology with a concrete agent roster.
1014 Multiagent orchestration configuration. Null when the agent is single-threaded.
10151015
10161016 - `type: "coordinator"`
10171017
from line 1445
14451445 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
14461446 -d '{
14471447 "description": "updated",
1448 "multiagent": {
1449 "agents": [
1450 "agent_011CZkYqphY8vELVzwCUpqiQ",
1451 {
1452 "type": "self"
1453 }
1454 ],
1455 "type": "coordinator"
1456 },
14481457 "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.",
14491458 "version": 1
14501459 }'
api/beta/agents/versions Changed · +11 / -11 lines
from line 153
153153
154154 - `archived_at: string or null`
155155
156 A timestamp in RFC 3339 format
156 When the agent was archived. Null if not archived.
157157
158158 format: date-time
159159
from line 185
185185
186186 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
187187
188 - `string`
189
188190 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
189191
190192 The model that will power your agent.
from line 253
251253
252254 High-performance model for agents and coding
253255
254 - `string`
255
256256 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
257257
258 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
258 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
259259
260260 - `BetaManagedAgentsEffortLow object`
261261
from line 293
293293
294294 - `speed: optional "standard" or "fast"`
295295
296 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
296 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
297297
298298 - `"standard"`
299299
from line 301
301301
302302 - `multiagent: BetaManagedAgentsMultiagent or null`
303303
304 Resolved coordinator topology with a concrete agent roster.
304 Multiagent orchestration configuration. Null when the agent is single-threaded.
305305
306306 - `type: "coordinator"`
307307
api/beta/agents/versions/list Changed · +11 / -11 lines
from line 151
151151
152152 - `archived_at: string or null`
153153
154 A timestamp in RFC 3339 format
154 When the agent was archived. Null if not archived.
155155
156156 format: date-time
157157
from line 183
183183
184184 See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
185185
186 - `string`
187
186188 - `"claude-opus-5-5" or "claude-fable-5-1" or "claude-sonnet-5" or 12 more`
187189
188190 The model that will power your agent.
from line 251
249251
250252 High-performance model for agents and coding
251253
252 - `string`
253
254254 - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more`
255255
256 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
256 How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied.
257257
258258 - `BetaManagedAgentsEffortLow object`
259259
from line 291
291291
292292 - `speed: optional "standard" or "fast"`
293293
294 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
294 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.
295295
296296 - `"standard"`
297297
from line 299
299299
300300 - `multiagent: BetaManagedAgentsMultiagent or null`
301301
302 Resolved coordinator topology with a concrete agent roster.
302 Multiagent orchestration configuration. Null when the agent is single-threaded.
303303
304304 - `type: "coordinator"`
305305
api/beta/deployment_runs Changed · +17 / -17 lines
from line 193
193193
194194 - `agent: BetaManagedAgentsAgentReference`
195195
196 A resolved agent reference with a concrete version.
196 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
197197
198198 - `type: "agent"`
199199
from line 205
205205
206206 - `created_at: string`
207207
208 A timestamp in RFC 3339 format
208 Time this run record was persisted.
209209
210210 format: date-time
211211
from line 215
215215
216216 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
217217
218 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
218 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
219219
220220 - `BetaManagedAgentsEnvironmentArchivedRunError object`
221221
from line 383
383383
384384 - `trigger_context: BetaManagedAgentsTriggerContext`
385385
386 Describes what triggered a deployment run, with trigger-specific metadata.
386 What triggered this run and trigger-specific metadata.
387387
388388 - `BetaManagedAgentsScheduleTriggerContext object`
389389
from line 393
393393
394394 - `scheduled_at: string`
395395
396 A timestamp in RFC 3339 format
396 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
397397
398398 format: date-time
399399
from line 584
584584
585585 - `agent: BetaManagedAgentsAgentReference`
586586
587 A resolved agent reference with a concrete version.
587 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
588588
589589 - `type: "agent"`
590590
from line 596
596596
597597 - `created_at: string`
598598
599 A timestamp in RFC 3339 format
599 Time this run record was persisted.
600600
601601 format: date-time
602602
from line 606
606606
607607 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
608608
609 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
609 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
610610
611611 - `BetaManagedAgentsEnvironmentArchivedRunError object`
612612
from line 774
774774
775775 - `trigger_context: BetaManagedAgentsTriggerContext`
776776
777 Describes what triggered a deployment run, with trigger-specific metadata.
777 What triggered this run and trigger-specific metadata.
778778
779779 - `BetaManagedAgentsScheduleTriggerContext object`
780780
from line 784
784784
785785 - `scheduled_at: string`
786786
787 A timestamp in RFC 3339 format
787 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
788788
789789 format: date-time
790790
from line 856
856856
857857 - `agent: BetaManagedAgentsAgentReference`
858858
859 A resolved agent reference with a concrete version.
859 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
860860
861861 - `type: "agent"`
862862
from line 868
868868
869869 - `created_at: string`
870870
871 A timestamp in RFC 3339 format
871 Time this run record was persisted.
872872
873873 format: date-time
874874
from line 878
878878
879879 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
880880
881 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
881 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
882882
883883 - `BetaManagedAgentsEnvironmentArchivedRunError object`
884884
from line 1046
10461046
10471047 - `trigger_context: BetaManagedAgentsTriggerContext`
10481048
1049 Describes what triggered a deployment run, with trigger-specific metadata.
1049 What triggered this run and trigger-specific metadata.
10501050
10511051 - `BetaManagedAgentsScheduleTriggerContext object`
10521052
from line 1056
10561056
10571057 - `scheduled_at: string`
10581058
1059 A timestamp in RFC 3339 format
1059 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
10601060
10611061 format: date-time
10621062
from line 1156
11561156
11571157 - `scheduled_at: string`
11581158
1159 A timestamp in RFC 3339 format
1159 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
11601160
11611161 format: date-time
11621162
from line 1234
12341234
12351235 - `scheduled_at: string`
12361236
1237 A timestamp in RFC 3339 format
1237 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
12381238
12391239 format: date-time
12401240
api/beta/deployment_runs/list Changed · +5 / -5 lines
from line 191
191191
192192 - `agent: BetaManagedAgentsAgentReference`
193193
194 A resolved agent reference with a concrete version.
194 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
195195
196196 - `type: "agent"`
197197
from line 203
203203
204204 - `created_at: string`
205205
206 A timestamp in RFC 3339 format
206 Time this run record was persisted.
207207
208208 format: date-time
209209
from line 213
213213
214214 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
215215
216 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
216 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
217217
218218 - `BetaManagedAgentsEnvironmentArchivedRunError object`
219219
from line 381
381381
382382 - `trigger_context: BetaManagedAgentsTriggerContext`
383383
384 Describes what triggered a deployment run, with trigger-specific metadata.
384 What triggered this run and trigger-specific metadata.
385385
386386 - `BetaManagedAgentsScheduleTriggerContext object`
387387
from line 391
391391
392392 - `scheduled_at: string`
393393
394 A timestamp in RFC 3339 format
394 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
395395
396396 format: date-time
397397
api/beta/deployment_runs/retrieve Changed · +5 / -5 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `created_at: string`
155155
156 A timestamp in RFC 3339 format
156 Time this run record was persisted.
157157
158158 format: date-time
159159
from line 163
163163
164164 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
165165
166 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
166 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
167167
168168 - `BetaManagedAgentsEnvironmentArchivedRunError object`
169169
from line 331
331331
332332 - `trigger_context: BetaManagedAgentsTriggerContext`
333333
334 Describes what triggered a deployment run, with trigger-specific metadata.
334 What triggered this run and trigger-specific metadata.
335335
336336 - `BetaManagedAgentsScheduleTriggerContext object`
337337
from line 341
341341
342342 - `scheduled_at: string`
343343
344 A timestamp in RFC 3339 format
344 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
345345
346346 format: date-time
347347
api/beta/deployments Changed · +169 / -158 lines
from line 189
189189
190190 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
191191
192 Union type for image source variants.
192 The source of the image data.
193193
194194 - `BetaManagedAgentsBase64ImageSource object`
195195
from line 241
241241
242242 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
243243
244 Union type for document source variants.
244 The source of the document data.
245245
246246 - `BetaManagedAgentsBase64DocumentSource object`
247247
from line 327
327327
328328 - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
329329
330 Rubric for grading the quality of an outcome.
330 How to grade the outcome. Text or file reference.
331331
332332 - `BetaManagedAgentsFileRubricParams object`
333333
from line 383
383383
384384- `budget: optional BetaManagedAgentsBudgetLimit or null`
385385
386 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
386 Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions uncapped. The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.
387387
388388 - `type: "limit"`
389389
390390 - `max_list_cost: BetaMonetaryAmount`
391391
392 A monetary amount in a specific currency.
392 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
393393
394394 - `amount: string`
395395
from line 491
491491
492492 - `access: optional "read_write" or "read_only" or null`
493493
494 Access mode for an attached memory store.
494 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
495495
496496 - `"read_write"`
497497
from line 505
505505
506506- `schedule: optional BetaManagedAgentsScheduleParams or null`
507507
508 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
508 Optional recurring cron schedule. When present, the deployment fires automatically. Both expression and timezone are required when schedule is set.
509509
510510 - `type: "cron"`
511511
from line 539
539539
540540 - `agent: BetaManagedAgentsAgentReference`
541541
542 A resolved agent reference with a concrete version.
542 Reference to the agent this deployment runs, resolved to a concrete version.
543543
544544 - `type: "agent"`
545545
from line 551
551551
552552 - `archived_at: string or null`
553553
554 A timestamp in RFC 3339 format
554 Time the deployment was archived. Null if not archived.
555555
556556 format: date-time
557557
558558 - `created_at: string`
559559
560 A timestamp in RFC 3339 format
560 Time the deployment was created.
561561
562562 format: date-time
563563
from line 603
603603
604604 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
605605
606 Union type for image source variants.
606 The source of the image data.
607607
608608 - `BetaManagedAgentsBase64ImageSource object`
609609
from line 655
655655
656656 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
657657
658 Union type for document source variants.
658 The source of the document data.
659659
660660 - `BetaManagedAgentsBase64DocumentSource object`
661661
from line 741
741741
742742 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
743743
744 Rubric for grading the quality of an outcome.
744 How to grade the outcome. Text or file reference.
745745
746746 - `BetaManagedAgentsFileRubric object`
747747
from line 797
797797
798798 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
799799
800 Why a deployment is paused. Non-null exactly when `status` is `paused`.
800 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
801801
802802 - `BetaManagedAgentsManualDeploymentPausedReason object`
803803
from line 813
813813
814814 - `error: BetaManagedAgentsDeploymentPausedReasonError`
815815
816 The error that triggered an auto-pause. Matches the failed run's `error.type`.
816 The failed run's error.
817817
818818 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
819819
from line 967
967967
968968 - `access: optional "read_write" or "read_only" or null`
969969
970 Access mode for an attached memory store.
970 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
971971
972972 - `"read_write"`
973973
from line 979
979979
980980 - `schedule: BetaManagedAgentsSchedule or null`
981981
982 5-field POSIX cron schedule with computed runtime timestamps.
982 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
983983
984984 - `type: "cron"`
985985
from line 997
997997
998998 - `last_run_at: optional string or null`
999999
1000 A timestamp in RFC 3339 format
1000 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
10011001
10021002 format: date-time
10031003
from line 1007
10071007
10081008 - `status: BetaManagedAgentsDeploymentStatus`
10091009
1010 Lifecycle status of a deployment.
1010 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
10111011
10121012 - `"active"`
10131013
from line 1019
10191019
10201020 - `updated_at: string`
10211021
1022 A timestamp in RFC 3339 format
1022 Time the deployment was last updated.
10231023
10241024 format: date-time
10251025
from line 1029
10291029
10301030 - `budget: optional BetaManagedAgentsBudgetLimit or null`
10311031
1032 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
1032 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
10331033
10341034 - `type: "limit"`
10351035
10361036 - `max_list_cost: BetaMonetaryAmount`
10371037
1038 A monetary amount in a specific currency.
1038 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
10391039
10401040 - `amount: string`
10411041
from line 1067
10671067 "type": "user.message"
10681068 }
10691069 ],
1070 "name": "x"
1070 "name": "x",
1071 "schedule": {
1072 "expression": "0 9 * * 1-5",
1073 "timezone": "America/Los_Angeles",
1074 "type": "cron"
1075 }
10711076 }'
10721077```
10731078
from line 1319
13141319
13151320 - `agent: BetaManagedAgentsAgentReference`
13161321
1317 A resolved agent reference with a concrete version.
1322 Reference to the agent this deployment runs, resolved to a concrete version.
13181323
13191324 - `type: "agent"`
13201325
from line 1331
13261331
13271332 - `archived_at: string or null`
13281333
1329 A timestamp in RFC 3339 format
1334 Time the deployment was archived. Null if not archived.
13301335
13311336 format: date-time
13321337
13331338 - `created_at: string`
13341339
1335 A timestamp in RFC 3339 format
1340 Time the deployment was created.
13361341
13371342 format: date-time
13381343
from line 1383
13781383
13791384 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
13801385
1381 Union type for image source variants.
1386 The source of the image data.
13821387
13831388 - `BetaManagedAgentsBase64ImageSource object`
13841389
from line 1435
14301435
14311436 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
14321437
1433 Union type for document source variants.
1438 The source of the document data.
14341439
14351440 - `BetaManagedAgentsBase64DocumentSource object`
14361441
from line 1521
15161521
15171522 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
15181523
1519 Rubric for grading the quality of an outcome.
1524 How to grade the outcome. Text or file reference.
15201525
15211526 - `BetaManagedAgentsFileRubric object`
15221527
from line 1577
15721577
15731578 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
15741579
1575 Why a deployment is paused. Non-null exactly when `status` is `paused`.
1580 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
15761581
15771582 - `BetaManagedAgentsManualDeploymentPausedReason object`
15781583
from line 1593
15881593
15891594 - `error: BetaManagedAgentsDeploymentPausedReasonError`
15901595
1591 The error that triggered an auto-pause. Matches the failed run's `error.type`.
1596 The failed run's error.
15921597
15931598 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
15941599
from line 1747
17421747
17431748 - `access: optional "read_write" or "read_only" or null`
17441749
1745 Access mode for an attached memory store.
1750 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
17461751
17471752 - `"read_write"`
17481753
from line 1759
17541759
17551760 - `schedule: BetaManagedAgentsSchedule or null`
17561761
1757 5-field POSIX cron schedule with computed runtime timestamps.
1762 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
17581763
17591764 - `type: "cron"`
17601765
from line 1777
17721777
17731778 - `last_run_at: optional string or null`
17741779
1775 A timestamp in RFC 3339 format
1780 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
17761781
17771782 format: date-time
17781783
from line 1787
17821787
17831788 - `status: BetaManagedAgentsDeploymentStatus`
17841789
1785 Lifecycle status of a deployment.
1790 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
17861791
17871792 - `"active"`
17881793
from line 1799
17941799
17951800 - `updated_at: string`
17961801
1797 A timestamp in RFC 3339 format
1802 Time the deployment was last updated.
17981803
17991804 format: date-time
18001805
from line 1809
18041809
18051810 - `budget: optional BetaManagedAgentsBudgetLimit or null`
18061811
1807 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
1812 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
18081813
18091814 - `type: "limit"`
18101815
18111816 - `max_list_cost: BetaMonetaryAmount`
18121817
1813 A monetary amount in a specific currency.
1818 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
18141819
18151820 - `amount: string`
18161821
from line 2048
20432048
20442049 - `agent: BetaManagedAgentsAgentReference`
20452050
2046 A resolved agent reference with a concrete version.
2051 Reference to the agent this deployment runs, resolved to a concrete version.
20472052
20482053 - `type: "agent"`
20492054
from line 2060
20552060
20562061 - `archived_at: string or null`
20572062
2058 A timestamp in RFC 3339 format
2063 Time the deployment was archived. Null if not archived.
20592064
20602065 format: date-time
20612066
20622067 - `created_at: string`
20632068
2064 A timestamp in RFC 3339 format
2069 Time the deployment was created.
20652070
20662071 format: date-time
20672072
from line 2112
21072112
21082113 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
21092114
2110 Union type for image source variants.
2115 The source of the image data.
21112116
21122117 - `BetaManagedAgentsBase64ImageSource object`
21132118
from line 2164
21592164
21602165 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
21612166
2162 Union type for document source variants.
2167 The source of the document data.
21632168
21642169 - `BetaManagedAgentsBase64DocumentSource object`
21652170
from line 2250
22452250
22462251 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
22472252
2248 Rubric for grading the quality of an outcome.
2253 How to grade the outcome. Text or file reference.
22492254
22502255 - `BetaManagedAgentsFileRubric object`
22512256
from line 2306
23012306
23022307 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
23032308
2304 Why a deployment is paused. Non-null exactly when `status` is `paused`.
2309 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
23052310
23062311 - `BetaManagedAgentsManualDeploymentPausedReason object`
23072312
from line 2322
23172322
23182323 - `error: BetaManagedAgentsDeploymentPausedReasonError`
23192324
2320 The error that triggered an auto-pause. Matches the failed run's `error.type`.
2325 The failed run's error.
23212326
23222327 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
23232328
from line 2476
24712476
24722477 - `access: optional "read_write" or "read_only" or null`
24732478
2474 Access mode for an attached memory store.
2479 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
24752480
24762481 - `"read_write"`
24772482
from line 2488
24832488
24842489 - `schedule: BetaManagedAgentsSchedule or null`
24852490
2486 5-field POSIX cron schedule with computed runtime timestamps.
2491 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
24872492
24882493 - `type: "cron"`
24892494
from line 2506
25012506
25022507 - `last_run_at: optional string or null`
25032508
2504 A timestamp in RFC 3339 format
2509 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
25052510
25062511 format: date-time
25072512
from line 2516
25112516
25122517 - `status: BetaManagedAgentsDeploymentStatus`
25132518
2514 Lifecycle status of a deployment.
2519 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
25152520
25162521 - `"active"`
25172522
from line 2528
25232528
25242529 - `updated_at: string`
25252530
2526 A timestamp in RFC 3339 format
2531 Time the deployment was last updated.
25272532
25282533 format: date-time
25292534
from line 2538
25332538
25342539 - `budget: optional BetaManagedAgentsBudgetLimit or null`
25352540
2536 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
2541 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
25372542
25382543 - `type: "limit"`
25392544
25402545 - `max_list_cost: BetaMonetaryAmount`
25412546
2542 A monetary amount in a specific currency.
2547 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
25432548
25442549 - `amount: string`
25452550
from line 2782
27772782
27782783- `budget: optional BetaManagedAgentsBudgetLimit or null`
27792784
2780 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
2785 Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.
27812786
27822787 - `type: "limit"`
27832788
27842789 - `max_list_cost: BetaMonetaryAmount`
27852790
2786 A monetary amount in a specific currency.
2791 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
27872792
27882793 - `amount: string`
27892794
from line 2844
28392844
28402845 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
28412846
2842 Union type for image source variants.
2847 The source of the image data.
28432848
28442849 - `BetaManagedAgentsBase64ImageSource object`
28452850
from line 2896
28912896
28922897 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
28932898
2894 Union type for document source variants.
2899 The source of the document data.
28952900
28962901 - `BetaManagedAgentsBase64DocumentSource object`
28972902
from line 2982
29772982
29782983 - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
29792984
2980 Rubric for grading the quality of an outcome.
2985 How to grade the outcome. Text or file reference.
29812986
29822987 - `BetaManagedAgentsFileRubricParams object`
29832988
from line 3122
31173122
31183123 - `access: optional "read_write" or "read_only" or null`
31193124
3120 Access mode for an attached memory store.
3125 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
31213126
31223127 - `"read_write"`
31233128
from line 3136
31313136
31323137- `schedule: optional BetaManagedAgentsScheduleParams or null`
31333138
3134 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
3139 Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only).
31353140
31363141 - `type: "cron"`
31373142
from line 3170
31653170
31663171 - `agent: BetaManagedAgentsAgentReference`
31673172
3168 A resolved agent reference with a concrete version.
3173 Reference to the agent this deployment runs, resolved to a concrete version.
31693174
31703175 - `type: "agent"`
31713176
from line 3182
31773182
31783183 - `archived_at: string or null`
31793184
3180 A timestamp in RFC 3339 format
3185 Time the deployment was archived. Null if not archived.
31813186
31823187 format: date-time
31833188
31843189 - `created_at: string`
31853190
3186 A timestamp in RFC 3339 format
3191 Time the deployment was created.
31873192
31883193 format: date-time
31893194
from line 3234
32293234
32303235 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
32313236
3232 Union type for image source variants.
3237 The source of the image data.
32333238
32343239 - `BetaManagedAgentsBase64ImageSource object`
32353240
from line 3286
32813286
32823287 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
32833288
3284 Union type for document source variants.
3289 The source of the document data.
32853290
32863291 - `BetaManagedAgentsBase64DocumentSource object`
32873292
from line 3372
33673372
33683373 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
33693374
3370 Rubric for grading the quality of an outcome.
3375 How to grade the outcome. Text or file reference.
33713376
33723377 - `BetaManagedAgentsFileRubric object`
33733378
from line 3428
34233428
34243429 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
34253430
3426 Why a deployment is paused. Non-null exactly when `status` is `paused`.
3431 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
34273432
34283433 - `BetaManagedAgentsManualDeploymentPausedReason object`
34293434
from line 3444
34393444
34403445 - `error: BetaManagedAgentsDeploymentPausedReasonError`
34413446
3442 The error that triggered an auto-pause. Matches the failed run's `error.type`.
3447 The failed run's error.
34433448
34443449 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
34453450
from line 3598
35933598
35943599 - `access: optional "read_write" or "read_only" or null`
35953600
3596 Access mode for an attached memory store.
3601 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
35973602
35983603 - `"read_write"`
35993604
from line 3610
36053610
36063611 - `schedule: BetaManagedAgentsSchedule or null`
36073612
3608 5-field POSIX cron schedule with computed runtime timestamps.
3613 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
36093614
36103615 - `type: "cron"`
36113616
from line 3628
36233628
36243629 - `last_run_at: optional string or null`
36253630
3626 A timestamp in RFC 3339 format
3631 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
36273632
36283633 format: date-time
36293634
from line 3638
36333638
36343639 - `status: BetaManagedAgentsDeploymentStatus`
36353640
3636 Lifecycle status of a deployment.
3641 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
36373642
36383643 - `"active"`
36393644
from line 3650
36453650
36463651 - `updated_at: string`
36473652
3648 A timestamp in RFC 3339 format
3653 Time the deployment was last updated.
36493654
36503655 format: date-time
36513656
from line 3660
36553660
36563661 - `budget: optional BetaManagedAgentsBudgetLimit or null`
36573662
3658 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
3663 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
36593664
36603665 - `type: "limit"`
36613666
36623667 - `max_list_cost: BetaMonetaryAmount`
36633668
3664 A monetary amount in a specific currency.
3669 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
36653670
36663671 - `amount: string`
36673672
from line 3684
36793684 -H 'anthropic-version: 2023-06-01' \
36803685 -H 'anthropic-beta: managed-agents-2026-04-01' \
36813686 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
3682 -d '{}'
3687 -d '{
3688 "schedule": {
3689 "expression": "0 9 * * 1-5",
3690 "timezone": "America/Los_Angeles",
3691 "type": "cron"
3692 }
3693 }'
36833694```
36843695
36853696#### Response (200)
from line 3898
38873898
38883899 - `agent: BetaManagedAgentsAgentReference`
38893900
3890 A resolved agent reference with a concrete version.
3901 Reference to the agent this deployment runs, resolved to a concrete version.
38913902
38923903 - `type: "agent"`
38933904
from line 3910
38993910
39003911 - `archived_at: string or null`
39013912
3902 A timestamp in RFC 3339 format
3913 Time the deployment was archived. Null if not archived.
39033914
39043915 format: date-time
39053916
39063917 - `created_at: string`
39073918
3908 A timestamp in RFC 3339 format
3919 Time the deployment was created.
39093920
39103921 format: date-time
39113922
from line 3962
39513962
39523963 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
39533964
3954 Union type for image source variants.
3965 The source of the image data.
39553966
39563967 - `BetaManagedAgentsBase64ImageSource object`
39573968
from line 4014
40034014
40044015 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
40054016
4006 Union type for document source variants.
4017 The source of the document data.
40074018
40084019 - `BetaManagedAgentsBase64DocumentSource object`
40094020
from line 4100
40894100
40904101 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
40914102
4092 Rubric for grading the quality of an outcome.
4103 How to grade the outcome. Text or file reference.
40934104
40944105 - `BetaManagedAgentsFileRubric object`
40954106
from line 4156
41454156
41464157 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
41474158
4148 Why a deployment is paused. Non-null exactly when `status` is `paused`.
4159 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
41494160
41504161 - `BetaManagedAgentsManualDeploymentPausedReason object`
41514162
from line 4172
41614172
41624173 - `error: BetaManagedAgentsDeploymentPausedReasonError`
41634174
4164 The error that triggered an auto-pause. Matches the failed run's `error.type`.
4175 The failed run's error.
41654176
41664177 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
41674178
from line 4326
43154326
43164327 - `access: optional "read_write" or "read_only" or null`
43174328
4318 Access mode for an attached memory store.
4329 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
43194330
43204331 - `"read_write"`
43214332
from line 4338
43274338
43284339 - `schedule: BetaManagedAgentsSchedule or null`
43294340
4330 5-field POSIX cron schedule with computed runtime timestamps.
4341 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
43314342
43324343 - `type: "cron"`
43334344
from line 4356
43454356
43464357 - `last_run_at: optional string or null`
43474358
4348 A timestamp in RFC 3339 format
4359 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
43494360
43504361 format: date-time
43514362
from line 4366
43554366
43564367 - `status: BetaManagedAgentsDeploymentStatus`
43574368
4358 Lifecycle status of a deployment.
4369 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
43594370
43604371 - `"active"`
43614372
from line 4378
43674378
43684379 - `updated_at: string`
43694380
4370 A timestamp in RFC 3339 format
4381 Time the deployment was last updated.
43714382
43724383 format: date-time
43734384
from line 4388
43774388
43784389 - `budget: optional BetaManagedAgentsBudgetLimit or null`
43794390
4380 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
4391 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
43814392
43824393 - `type: "limit"`
43834394
43844395 - `max_list_cost: BetaMonetaryAmount`
43854396
4386 A monetary amount in a specific currency.
4397 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
43874398
43884399 - `amount: string`
43894400
from line 4619
46084619
46094620 - `agent: BetaManagedAgentsAgentReference`
46104621
4611 A resolved agent reference with a concrete version.
4622 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
46124623
46134624 - `type: "agent"`
46144625
from line 4631
46204631
46214632 - `created_at: string`
46224633
4623 A timestamp in RFC 3339 format
4634 Time this run record was persisted.
46244635
46254636 format: date-time
46264637
from line 4641
46304641
46314642 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
46324643
4633 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
4644 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
46344645
46354646 - `BetaManagedAgentsEnvironmentArchivedRunError object`
46364647
from line 4809
47984809
47994810 - `trigger_context: BetaManagedAgentsTriggerContext`
48004811
4801 Describes what triggered a deployment run, with trigger-specific metadata.
4812 What triggered this run and trigger-specific metadata.
48024813
48034814 - `BetaManagedAgentsScheduleTriggerContext object`
48044815
from line 4819
48084819
48094820 - `scheduled_at: string`
48104821
4811 A timestamp in RFC 3339 format
4822 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
48124823
48134824 format: date-time
48144825
from line 5002
49915002
49925003 - `agent: BetaManagedAgentsAgentReference`
49935004
4994 A resolved agent reference with a concrete version.
5005 Reference to the agent this deployment runs, resolved to a concrete version.
49955006
49965007 - `type: "agent"`
49975008
from line 5014
50035014
50045015 - `archived_at: string or null`
50055016
5006 A timestamp in RFC 3339 format
5017 Time the deployment was archived. Null if not archived.
50075018
50085019 format: date-time
50095020
50105021 - `created_at: string`
50115022
5012 A timestamp in RFC 3339 format
5023 Time the deployment was created.
50135024
50145025 format: date-time
50155026
from line 5066
50555066
50565067 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
50575068
5058 Union type for image source variants.
5069 The source of the image data.
50595070
50605071 - `BetaManagedAgentsBase64ImageSource object`
50615072
from line 5118
51075118
51085119 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
51095120
5110 Union type for document source variants.
5121 The source of the document data.
51115122
51125123 - `BetaManagedAgentsBase64DocumentSource object`
51135124
from line 5204
51935204
51945205 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
51955206
5196 Rubric for grading the quality of an outcome.
5207 How to grade the outcome. Text or file reference.
51975208
51985209 - `BetaManagedAgentsFileRubric object`
51995210
from line 5260
52495260
52505261 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
52515262
5252 Why a deployment is paused. Non-null exactly when `status` is `paused`.
5263 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
52535264
52545265 - `BetaManagedAgentsManualDeploymentPausedReason object`
52555266
from line 5276
52655276
52665277 - `error: BetaManagedAgentsDeploymentPausedReasonError`
52675278
5268 The error that triggered an auto-pause. Matches the failed run's `error.type`.
5279 The failed run's error.
52695280
52705281 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
52715282
from line 5430
54195430
54205431 - `access: optional "read_write" or "read_only" or null`
54215432
5422 Access mode for an attached memory store.
5433 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
54235434
54245435 - `"read_write"`
54255436
from line 5442
54315442
54325443 - `schedule: BetaManagedAgentsSchedule or null`
54335444
5434 5-field POSIX cron schedule with computed runtime timestamps.
5445 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
54355446
54365447 - `type: "cron"`
54375448
from line 5460
54495460
54505461 - `last_run_at: optional string or null`
54515462
5452 A timestamp in RFC 3339 format
5463 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
54535464
54545465 format: date-time
54555466
from line 5470
54595470
54605471 - `status: BetaManagedAgentsDeploymentStatus`
54615472
5462 Lifecycle status of a deployment.
5473 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
54635474
54645475 - `"active"`
54655476
from line 5482
54715482
54725483 - `updated_at: string`
54735484
5474 A timestamp in RFC 3339 format
5485 Time the deployment was last updated.
54755486
54765487 format: date-time
54775488
from line 5492
54815492
54825493 - `budget: optional BetaManagedAgentsBudgetLimit or null`
54835494
5484 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
5495 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
54855496
54865497 - `type: "limit"`
54875498
54885499 - `max_list_cost: BetaMonetaryAmount`
54895500
5490 A monetary amount in a specific currency.
5501 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
54915502
54925503 - `amount: string`
54935504
from line 5723
57125723
57135724 - `agent: BetaManagedAgentsAgentReference`
57145725
5715 A resolved agent reference with a concrete version.
5726 Reference to the agent this deployment runs, resolved to a concrete version.
57165727
57175728 - `type: "agent"`
57185729
from line 5735
57245735
57255736 - `archived_at: string or null`
57265737
5727 A timestamp in RFC 3339 format
5738 Time the deployment was archived. Null if not archived.
57285739
57295740 format: date-time
57305741
57315742 - `created_at: string`
57325743
5733 A timestamp in RFC 3339 format
5744 Time the deployment was created.
57345745
57355746 format: date-time
57365747
from line 5787
57765787
57775788 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
57785789
5779 Union type for image source variants.
5790 The source of the image data.
57805791
57815792 - `BetaManagedAgentsBase64ImageSource object`
57825793
from line 5839
58285839
58295840 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
58305841
5831 Union type for document source variants.
5842 The source of the document data.
58325843
58335844 - `BetaManagedAgentsBase64DocumentSource object`
58345845
from line 5925
59145925
59155926 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
59165927
5917 Rubric for grading the quality of an outcome.
5928 How to grade the outcome. Text or file reference.
59185929
59195930 - `BetaManagedAgentsFileRubric object`
59205931
from line 5981
59705981
59715982 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
59725983
5973 Why a deployment is paused. Non-null exactly when `status` is `paused`.
5984 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
59745985
59755986 - `BetaManagedAgentsManualDeploymentPausedReason object`
59765987
from line 5997
59865997
59875998 - `error: BetaManagedAgentsDeploymentPausedReasonError`
59885999
5989 The error that triggered an auto-pause. Matches the failed run's `error.type`.
6000 The failed run's error.
59906001
59916002 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
59926003
from line 6151
61406151
61416152 - `access: optional "read_write" or "read_only" or null`
61426153
6143 Access mode for an attached memory store.
6154 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
61446155
61456156 - `"read_write"`
61466157
from line 6163
61526163
61536164 - `schedule: BetaManagedAgentsSchedule or null`
61546165
6155 5-field POSIX cron schedule with computed runtime timestamps.
6166 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
61566167
61576168 - `type: "cron"`
61586169
from line 6181
61706181
61716182 - `last_run_at: optional string or null`
61726183
6173 A timestamp in RFC 3339 format
6184 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
61746185
61756186 format: date-time
61766187
from line 6191
61806191
61816192 - `status: BetaManagedAgentsDeploymentStatus`
61826193
6183 Lifecycle status of a deployment.
6194 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
61846195
61856196 - `"active"`
61866197
from line 6203
61926203
61936204 - `updated_at: string`
61946205
6195 A timestamp in RFC 3339 format
6206 Time the deployment was last updated.
61966207
61976208 format: date-time
61986209
from line 6213
62026213
62036214 - `budget: optional BetaManagedAgentsBudgetLimit or null`
62046215
6205 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
6216 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
62066217
62076218 - `type: "limit"`
62086219
62096220 - `max_list_cost: BetaMonetaryAmount`
62106221
6211 A monetary amount in a specific currency.
6222 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
62126223
62136224 - `amount: string`
62146225
from line 6338
63276338
63286339 - `last_run_at: optional string or null`
63296340
6330 A timestamp in RFC 3339 format
6341 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
63316342
63326343 format: date-time
63336344
from line 6380
63696380
63706381 - `agent: BetaManagedAgentsAgentReference`
63716382
6372 A resolved agent reference with a concrete version.
6383 Reference to the agent this deployment runs, resolved to a concrete version.
63736384
63746385 - `type: "agent"`
63756386
from line 6392
63816392
63826393 - `archived_at: string or null`
63836394
6384 A timestamp in RFC 3339 format
6395 Time the deployment was archived. Null if not archived.
63856396
63866397 format: date-time
63876398
63886399 - `created_at: string`
63896400
6390 A timestamp in RFC 3339 format
6401 Time the deployment was created.
63916402
63926403 format: date-time
63936404
from line 6444
64336444
64346445 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
64356446
6436 Union type for image source variants.
6447 The source of the image data.
64376448
64386449 - `BetaManagedAgentsBase64ImageSource object`
64396450
from line 6496
64856496
64866497 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
64876498
6488 Union type for document source variants.
6499 The source of the document data.
64896500
64906501 - `BetaManagedAgentsBase64DocumentSource object`
64916502
from line 6582
65716582
65726583 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
65736584
6574 Rubric for grading the quality of an outcome.
6585 How to grade the outcome. Text or file reference.
65756586
65766587 - `BetaManagedAgentsFileRubric object`
65776588
from line 6638
66276638
66286639 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
66296640
6630 Why a deployment is paused. Non-null exactly when `status` is `paused`.
6641 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
66316642
66326643 - `BetaManagedAgentsManualDeploymentPausedReason object`
66336644
from line 6654
66436654
66446655 - `error: BetaManagedAgentsDeploymentPausedReasonError`
66456656
6646 The error that triggered an auto-pause. Matches the failed run's `error.type`.
6657 The failed run's error.
66476658
66486659 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
66496660
from line 6808
67976808
67986809 - `access: optional "read_write" or "read_only" or null`
67996810
6800 Access mode for an attached memory store.
6811 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
68016812
68026813 - `"read_write"`
68036814
from line 6820
68096820
68106821 - `schedule: BetaManagedAgentsSchedule or null`
68116822
6812 5-field POSIX cron schedule with computed runtime timestamps.
6823 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
68136824
68146825 - `type: "cron"`
68156826
from line 6838
68276838
68286839 - `last_run_at: optional string or null`
68296840
6830 A timestamp in RFC 3339 format
6841 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
68316842
68326843 format: date-time
68336844
from line 6848
68376848
68386849 - `status: BetaManagedAgentsDeploymentStatus`
68396850
6840 Lifecycle status of a deployment.
6851 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
68416852
68426853 - `"active"`
68436854
from line 6860
68496860
68506861 - `updated_at: string`
68516862
6852 A timestamp in RFC 3339 format
6863 Time the deployment was last updated.
68536864
68546865 format: date-time
68556866
from line 6870
68596870
68606871 - `budget: optional BetaManagedAgentsBudgetLimit or null`
68616872
6862 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
6873 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
68636874
68646875 - `type: "limit"`
68656876
68666877 - `max_list_cost: BetaMonetaryAmount`
68676878
6868 A monetary amount in a specific currency.
6879 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
68696880
68706881 - `amount: string`
68716882
from line 6922
69116922
69126923 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
69136924
6914 Union type for image source variants.
6925 The source of the image data.
69156926
69166927 - `BetaManagedAgentsBase64ImageSource object`
69176928
from line 6974
69636974
69646975 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
69656976
6966 Union type for document source variants.
6977 The source of the document data.
69676978
69686979 - `BetaManagedAgentsBase64DocumentSource object`
69696980
from line 7060
70497060
70507061 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
70517062
7052 Rubric for grading the quality of an outcome.
7063 How to grade the outcome. Text or file reference.
70537064
70547065 - `BetaManagedAgentsFileRubric object`
70557066
from line 7142
71317142
71327143 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
71337144
7134 Union type for image source variants.
7145 The source of the image data.
71357146
71367147 - `BetaManagedAgentsBase64ImageSource object`
71377148
from line 7194
71837194
71847195 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
71857196
7186 Union type for document source variants.
7197 The source of the document data.
71877198
71887199 - `BetaManagedAgentsBase64DocumentSource object`
71897200
from line 7280
72697280
72707281 - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
72717282
7272 Rubric for grading the quality of an outcome.
7283 How to grade the outcome. Text or file reference.
72737284
72747285 - `BetaManagedAgentsFileRubricParams object`
72757286
from line 7348
73377348
73387349 - `error: BetaManagedAgentsDeploymentPausedReasonError`
73397350
7340 The error that triggered an auto-pause. Matches the failed run's `error.type`.
7351 The failed run's error.
73417352
73427353 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
73437354
from line 7572
75617572
75627573 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
75637574
7564 Rubric for grading the quality of an outcome.
7575 How to grade the outcome. Text or file reference.
75657576
75667577 - `BetaManagedAgentsFileRubric object`
75677578
from line 7632
76217632
76227633 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
76237634
7624 Union type for image source variants.
7635 The source of the image data.
76257636
76267637 - `BetaManagedAgentsBase64ImageSource object`
76277638
from line 7684
76737684
76747685 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
76757686
7676 Union type for document source variants.
7687 The source of the document data.
76777688
76787689 - `BetaManagedAgentsBase64DocumentSource object`
76797690
from line 7784
77737784
77747785 - `error: BetaManagedAgentsDeploymentPausedReasonError`
77757786
7776 The error that triggered an auto-pause. Matches the failed run's `error.type`.
7787 The failed run's error.
77777788
77787789 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
77797790
from line 7972
79617972
79627973 - `access: optional "read_write" or "read_only" or null`
79637974
7964 Access mode for an attached memory store.
7975 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
79657976
79667977 - `"read_write"`
79677978
from line 7994
79837994
79847995- `BetaManagedAgentsSchedule object`
79857996
7986 5-field POSIX cron schedule with computed runtime timestamps.
7997 A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently.
79877998
79887999 - `type: "cron"`
79898000
from line 8012
80018012
80028013 - `last_run_at: optional string or null`
80038014
8004 A timestamp in RFC 3339 format
8015 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
80058016
80068017 format: date-time
80078018
from line 8024
80138024
80148025- `BetaManagedAgentsScheduleParams object`
80158026
8016 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
8027 A recurring schedule. Discriminated union — only cron is supported currently.
80178028
80188029 - `type: "cron"`
80198030
from line 8118
81078118
81088119 - `access: optional "read_write" or "read_only" or null`
81098120
8110 Access mode for an attached memory store.
8121 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
81118122
81128123 - `"read_write"`
81138124
api/beta/deployments/archive Changed · +15 / -15 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Reference to the agent this deployment runs, resolved to a concrete version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `archived_at: string or null`
155155
156 A timestamp in RFC 3339 format
156 Time the deployment was archived. Null if not archived.
157157
158158 format: date-time
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 Time the deployment was created.
163163
164164 format: date-time
165165
from line 205
205205
206206 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
207207
208 Union type for image source variants.
208 The source of the image data.
209209
210210 - `BetaManagedAgentsBase64ImageSource object`
211211
from line 257
257257
258258 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
259259
260 Union type for document source variants.
260 The source of the document data.
261261
262262 - `BetaManagedAgentsBase64DocumentSource object`
263263
from line 343
343343
344344 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
345345
346 Rubric for grading the quality of an outcome.
346 How to grade the outcome. Text or file reference.
347347
348348 - `BetaManagedAgentsFileRubric object`
349349
from line 399
399399
400400 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
401401
402 Why a deployment is paused. Non-null exactly when `status` is `paused`.
402 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
403403
404404 - `BetaManagedAgentsManualDeploymentPausedReason object`
405405
from line 415
415415
416416 - `error: BetaManagedAgentsDeploymentPausedReasonError`
417417
418 The error that triggered an auto-pause. Matches the failed run's `error.type`.
418 The failed run's error.
419419
420420 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
421421
from line 569
569569
570570 - `access: optional "read_write" or "read_only" or null`
571571
572 Access mode for an attached memory store.
572 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
573573
574574 - `"read_write"`
575575
from line 581
581581
582582 - `schedule: BetaManagedAgentsSchedule or null`
583583
584 5-field POSIX cron schedule with computed runtime timestamps.
584 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
585585
586586 - `type: "cron"`
587587
from line 599
599599
600600 - `last_run_at: optional string or null`
601601
602 A timestamp in RFC 3339 format
602 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
603603
604604 format: date-time
605605
from line 609
609609
610610 - `status: BetaManagedAgentsDeploymentStatus`
611611
612 Lifecycle status of a deployment.
612 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
613613
614614 - `"active"`
615615
from line 621
621621
622622 - `updated_at: string`
623623
624 A timestamp in RFC 3339 format
624 Time the deployment was last updated.
625625
626626 format: date-time
627627
from line 631
631631
632632 - `budget: optional BetaManagedAgentsBudgetLimit or null`
633633
634 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
634 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
635635
636636 - `type: "limit"`
637637
638638 - `max_list_cost: BetaMonetaryAmount`
639639
640 A monetary amount in a specific currency.
640 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
641641
642642 - `amount: string`
643643
api/beta/deployments/create Changed · +28 / -23 lines
from line 187
187187
188188 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
189189
190 Union type for image source variants.
190 The source of the image data.
191191
192192 - `BetaManagedAgentsBase64ImageSource object`
193193
from line 239
239239
240240 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
241241
242 Union type for document source variants.
242 The source of the document data.
243243
244244 - `BetaManagedAgentsBase64DocumentSource object`
245245
from line 325
325325
326326 - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
327327
328 Rubric for grading the quality of an outcome.
328 How to grade the outcome. Text or file reference.
329329
330330 - `BetaManagedAgentsFileRubricParams object`
331331
from line 381
381381
382382- `budget: optional BetaManagedAgentsBudgetLimit or null`
383383
384 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
384 Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions uncapped. The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.
385385
386386 - `type: "limit"`
387387
388388 - `max_list_cost: BetaMonetaryAmount`
389389
390 A monetary amount in a specific currency.
390 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
391391
392392 - `amount: string`
393393
from line 489
489489
490490 - `access: optional "read_write" or "read_only" or null`
491491
492 Access mode for an attached memory store.
492 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
493493
494494 - `"read_write"`
495495
from line 503
503503
504504- `schedule: optional BetaManagedAgentsScheduleParams or null`
505505
506 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
506 Optional recurring cron schedule. When present, the deployment fires automatically. Both expression and timezone are required when schedule is set.
507507
508508 - `type: "cron"`
509509
from line 537
537537
538538 - `agent: BetaManagedAgentsAgentReference`
539539
540 A resolved agent reference with a concrete version.
540 Reference to the agent this deployment runs, resolved to a concrete version.
541541
542542 - `type: "agent"`
543543
from line 549
549549
550550 - `archived_at: string or null`
551551
552 A timestamp in RFC 3339 format
552 Time the deployment was archived. Null if not archived.
553553
554554 format: date-time
555555
556556 - `created_at: string`
557557
558 A timestamp in RFC 3339 format
558 Time the deployment was created.
559559
560560 format: date-time
561561
from line 601
601601
602602 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
603603
604 Union type for image source variants.
604 The source of the image data.
605605
606606 - `BetaManagedAgentsBase64ImageSource object`
607607
from line 653
653653
654654 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
655655
656 Union type for document source variants.
656 The source of the document data.
657657
658658 - `BetaManagedAgentsBase64DocumentSource object`
659659
from line 739
739739
740740 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
741741
742 Rubric for grading the quality of an outcome.
742 How to grade the outcome. Text or file reference.
743743
744744 - `BetaManagedAgentsFileRubric object`
745745
from line 795
795795
796796 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
797797
798 Why a deployment is paused. Non-null exactly when `status` is `paused`.
798 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
799799
800800 - `BetaManagedAgentsManualDeploymentPausedReason object`
801801
from line 811
811811
812812 - `error: BetaManagedAgentsDeploymentPausedReasonError`
813813
814 The error that triggered an auto-pause. Matches the failed run's `error.type`.
814 The failed run's error.
815815
816816 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
817817
from line 965
965965
966966 - `access: optional "read_write" or "read_only" or null`
967967
968 Access mode for an attached memory store.
968 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
969969
970970 - `"read_write"`
971971
from line 977
977977
978978 - `schedule: BetaManagedAgentsSchedule or null`
979979
980 5-field POSIX cron schedule with computed runtime timestamps.
980 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
981981
982982 - `type: "cron"`
983983
from line 995
995995
996996 - `last_run_at: optional string or null`
997997
998 A timestamp in RFC 3339 format
998 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
999999
10001000 format: date-time
10011001
from line 1005
10051005
10061006 - `status: BetaManagedAgentsDeploymentStatus`
10071007
1008 Lifecycle status of a deployment.
1008 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
10091009
10101010 - `"active"`
10111011
from line 1017
10171017
10181018 - `updated_at: string`
10191019
1020 A timestamp in RFC 3339 format
1020 Time the deployment was last updated.
10211021
10221022 format: date-time
10231023
from line 1027
10271027
10281028 - `budget: optional BetaManagedAgentsBudgetLimit or null`
10291029
1030 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
1030 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
10311031
10321032 - `type: "limit"`
10331033
10341034 - `max_list_cost: BetaMonetaryAmount`
10351035
1036 A monetary amount in a specific currency.
1036 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
10371037
10381038 - `amount: string`
10391039
from line 1065
10651065 "type": "user.message"
10661066 }
10671067 ],
1068 "name": "x"
1068 "name": "x",
1069 "schedule": {
1070 "expression": "0 9 * * 1-5",
1071 "timezone": "America/Los_Angeles",
1072 "type": "cron"
1073 }
10691074 }'
10701075```
10711076
api/beta/deployments/list Changed · +15 / -15 lines
from line 179
179179
180180 - `agent: BetaManagedAgentsAgentReference`
181181
182 A resolved agent reference with a concrete version.
182 Reference to the agent this deployment runs, resolved to a concrete version.
183183
184184 - `type: "agent"`
185185
from line 191
191191
192192 - `archived_at: string or null`
193193
194 A timestamp in RFC 3339 format
194 Time the deployment was archived. Null if not archived.
195195
196196 format: date-time
197197
198198 - `created_at: string`
199199
200 A timestamp in RFC 3339 format
200 Time the deployment was created.
201201
202202 format: date-time
203203
from line 243
243243
244244 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
245245
246 Union type for image source variants.
246 The source of the image data.
247247
248248 - `BetaManagedAgentsBase64ImageSource object`
249249
from line 295
295295
296296 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
297297
298 Union type for document source variants.
298 The source of the document data.
299299
300300 - `BetaManagedAgentsBase64DocumentSource object`
301301
from line 381
381381
382382 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
383383
384 Rubric for grading the quality of an outcome.
384 How to grade the outcome. Text or file reference.
385385
386386 - `BetaManagedAgentsFileRubric object`
387387
from line 437
437437
438438 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
439439
440 Why a deployment is paused. Non-null exactly when `status` is `paused`.
440 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
441441
442442 - `BetaManagedAgentsManualDeploymentPausedReason object`
443443
from line 453
453453
454454 - `error: BetaManagedAgentsDeploymentPausedReasonError`
455455
456 The error that triggered an auto-pause. Matches the failed run's `error.type`.
456 The failed run's error.
457457
458458 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
459459
from line 607
607607
608608 - `access: optional "read_write" or "read_only" or null`
609609
610 Access mode for an attached memory store.
610 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
611611
612612 - `"read_write"`
613613
from line 619
619619
620620 - `schedule: BetaManagedAgentsSchedule or null`
621621
622 5-field POSIX cron schedule with computed runtime timestamps.
622 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
623623
624624 - `type: "cron"`
625625
from line 637
637637
638638 - `last_run_at: optional string or null`
639639
640 A timestamp in RFC 3339 format
640 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
641641
642642 format: date-time
643643
from line 647
647647
648648 - `status: BetaManagedAgentsDeploymentStatus`
649649
650 Lifecycle status of a deployment.
650 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
651651
652652 - `"active"`
653653
from line 659
659659
660660 - `updated_at: string`
661661
662 A timestamp in RFC 3339 format
662 Time the deployment was last updated.
663663
664664 format: date-time
665665
from line 669
669669
670670 - `budget: optional BetaManagedAgentsBudgetLimit or null`
671671
672 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
672 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
673673
674674 - `type: "limit"`
675675
676676 - `max_list_cost: BetaMonetaryAmount`
677677
678 A monetary amount in a specific currency.
678 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
679679
680680 - `amount: string`
681681
api/beta/deployments/pause Changed · +15 / -15 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Reference to the agent this deployment runs, resolved to a concrete version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `archived_at: string or null`
155155
156 A timestamp in RFC 3339 format
156 Time the deployment was archived. Null if not archived.
157157
158158 format: date-time
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 Time the deployment was created.
163163
164164 format: date-time
165165
from line 205
205205
206206 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
207207
208 Union type for image source variants.
208 The source of the image data.
209209
210210 - `BetaManagedAgentsBase64ImageSource object`
211211
from line 257
257257
258258 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
259259
260 Union type for document source variants.
260 The source of the document data.
261261
262262 - `BetaManagedAgentsBase64DocumentSource object`
263263
from line 343
343343
344344 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
345345
346 Rubric for grading the quality of an outcome.
346 How to grade the outcome. Text or file reference.
347347
348348 - `BetaManagedAgentsFileRubric object`
349349
from line 399
399399
400400 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
401401
402 Why a deployment is paused. Non-null exactly when `status` is `paused`.
402 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
403403
404404 - `BetaManagedAgentsManualDeploymentPausedReason object`
405405
from line 415
415415
416416 - `error: BetaManagedAgentsDeploymentPausedReasonError`
417417
418 The error that triggered an auto-pause. Matches the failed run's `error.type`.
418 The failed run's error.
419419
420420 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
421421
from line 569
569569
570570 - `access: optional "read_write" or "read_only" or null`
571571
572 Access mode for an attached memory store.
572 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
573573
574574 - `"read_write"`
575575
from line 581
581581
582582 - `schedule: BetaManagedAgentsSchedule or null`
583583
584 5-field POSIX cron schedule with computed runtime timestamps.
584 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
585585
586586 - `type: "cron"`
587587
from line 599
599599
600600 - `last_run_at: optional string or null`
601601
602 A timestamp in RFC 3339 format
602 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
603603
604604 format: date-time
605605
from line 609
609609
610610 - `status: BetaManagedAgentsDeploymentStatus`
611611
612 Lifecycle status of a deployment.
612 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
613613
614614 - `"active"`
615615
from line 621
621621
622622 - `updated_at: string`
623623
624 A timestamp in RFC 3339 format
624 Time the deployment was last updated.
625625
626626 format: date-time
627627
from line 631
631631
632632 - `budget: optional BetaManagedAgentsBudgetLimit or null`
633633
634 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
634 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
635635
636636 - `type: "limit"`
637637
638638 - `max_list_cost: BetaMonetaryAmount`
639639
640 A monetary amount in a specific currency.
640 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
641641
642642 - `amount: string`
643643
api/beta/deployments/retrieve Changed · +15 / -15 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Reference to the agent this deployment runs, resolved to a concrete version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `archived_at: string or null`
155155
156 A timestamp in RFC 3339 format
156 Time the deployment was archived. Null if not archived.
157157
158158 format: date-time
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 Time the deployment was created.
163163
164164 format: date-time
165165
from line 205
205205
206206 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
207207
208 Union type for image source variants.
208 The source of the image data.
209209
210210 - `BetaManagedAgentsBase64ImageSource object`
211211
from line 257
257257
258258 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
259259
260 Union type for document source variants.
260 The source of the document data.
261261
262262 - `BetaManagedAgentsBase64DocumentSource object`
263263
from line 343
343343
344344 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
345345
346 Rubric for grading the quality of an outcome.
346 How to grade the outcome. Text or file reference.
347347
348348 - `BetaManagedAgentsFileRubric object`
349349
from line 399
399399
400400 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
401401
402 Why a deployment is paused. Non-null exactly when `status` is `paused`.
402 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
403403
404404 - `BetaManagedAgentsManualDeploymentPausedReason object`
405405
from line 415
415415
416416 - `error: BetaManagedAgentsDeploymentPausedReasonError`
417417
418 The error that triggered an auto-pause. Matches the failed run's `error.type`.
418 The failed run's error.
419419
420420 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
421421
from line 569
569569
570570 - `access: optional "read_write" or "read_only" or null`
571571
572 Access mode for an attached memory store.
572 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
573573
574574 - `"read_write"`
575575
from line 581
581581
582582 - `schedule: BetaManagedAgentsSchedule or null`
583583
584 5-field POSIX cron schedule with computed runtime timestamps.
584 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
585585
586586 - `type: "cron"`
587587
from line 599
599599
600600 - `last_run_at: optional string or null`
601601
602 A timestamp in RFC 3339 format
602 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
603603
604604 format: date-time
605605
from line 609
609609
610610 - `status: BetaManagedAgentsDeploymentStatus`
611611
612 Lifecycle status of a deployment.
612 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
613613
614614 - `"active"`
615615
from line 621
621621
622622 - `updated_at: string`
623623
624 A timestamp in RFC 3339 format
624 Time the deployment was last updated.
625625
626626 format: date-time
627627
from line 631
631631
632632 - `budget: optional BetaManagedAgentsBudgetLimit or null`
633633
634 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
634 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
635635
636636 - `type: "limit"`
637637
638638 - `max_list_cost: BetaMonetaryAmount`
639639
640 A monetary amount in a specific currency.
640 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
641641
642642 - `amount: string`
643643
api/beta/deployments/run Changed · +5 / -5 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `created_at: string`
155155
156 A timestamp in RFC 3339 format
156 Time this run record was persisted.
157157
158158 format: date-time
159159
from line 163
163163
164164 - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
165165
166 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
166 Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null.
167167
168168 - `BetaManagedAgentsEnvironmentArchivedRunError object`
169169
from line 331
331331
332332 - `trigger_context: BetaManagedAgentsTriggerContext`
333333
334 Describes what triggered a deployment run, with trigger-specific metadata.
334 What triggered this run and trigger-specific metadata.
335335
336336 - `BetaManagedAgentsScheduleTriggerContext object`
337337
from line 341
341341
342342 - `scheduled_at: string`
343343
344 A timestamp in RFC 3339 format
344 The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair.
345345
346346 format: date-time
347347
api/beta/deployments/unpause Changed · +15 / -15 lines
from line 141
141141
142142 - `agent: BetaManagedAgentsAgentReference`
143143
144 A resolved agent reference with a concrete version.
144 Reference to the agent this deployment runs, resolved to a concrete version.
145145
146146 - `type: "agent"`
147147
from line 153
153153
154154 - `archived_at: string or null`
155155
156 A timestamp in RFC 3339 format
156 Time the deployment was archived. Null if not archived.
157157
158158 format: date-time
159159
160160 - `created_at: string`
161161
162 A timestamp in RFC 3339 format
162 Time the deployment was created.
163163
164164 format: date-time
165165
from line 205
205205
206206 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
207207
208 Union type for image source variants.
208 The source of the image data.
209209
210210 - `BetaManagedAgentsBase64ImageSource object`
211211
from line 257
257257
258258 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
259259
260 Union type for document source variants.
260 The source of the document data.
261261
262262 - `BetaManagedAgentsBase64DocumentSource object`
263263
from line 343
343343
344344 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
345345
346 Rubric for grading the quality of an outcome.
346 How to grade the outcome. Text or file reference.
347347
348348 - `BetaManagedAgentsFileRubric object`
349349
from line 399
399399
400400 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
401401
402 Why a deployment is paused. Non-null exactly when `status` is `paused`.
402 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
403403
404404 - `BetaManagedAgentsManualDeploymentPausedReason object`
405405
from line 415
415415
416416 - `error: BetaManagedAgentsDeploymentPausedReasonError`
417417
418 The error that triggered an auto-pause. Matches the failed run's `error.type`.
418 The failed run's error.
419419
420420 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
421421
from line 569
569569
570570 - `access: optional "read_write" or "read_only" or null`
571571
572 Access mode for an attached memory store.
572 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
573573
574574 - `"read_write"`
575575
from line 581
581581
582582 - `schedule: BetaManagedAgentsSchedule or null`
583583
584 5-field POSIX cron schedule with computed runtime timestamps.
584 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
585585
586586 - `type: "cron"`
587587
from line 599
599599
600600 - `last_run_at: optional string or null`
601601
602 A timestamp in RFC 3339 format
602 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
603603
604604 format: date-time
605605
from line 609
609609
610610 - `status: BetaManagedAgentsDeploymentStatus`
611611
612 Lifecycle status of a deployment.
612 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
613613
614614 - `"active"`
615615
from line 621
621621
622622 - `updated_at: string`
623623
624 A timestamp in RFC 3339 format
624 Time the deployment was last updated.
625625
626626 format: date-time
627627
from line 631
631631
632632 - `budget: optional BetaManagedAgentsBudgetLimit or null`
633633
634 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
634 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
635635
636636 - `type: "limit"`
637637
638638 - `max_list_cost: BetaMonetaryAmount`
639639
640 A monetary amount in a specific currency.
640 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
641641
642642 - `amount: string`
643643
api/beta/deployments/update Changed · +29 / -23 lines
from line 155
155155
156156- `budget: optional BetaManagedAgentsBudgetLimit or null`
157157
158 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
158 Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.
159159
160160 - `type: "limit"`
161161
162162 - `max_list_cost: BetaMonetaryAmount`
163163
164 A monetary amount in a specific currency.
164 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
165165
166166 - `amount: string`
167167
from line 217
217217
218218 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
219219
220 Union type for image source variants.
220 The source of the image data.
221221
222222 - `BetaManagedAgentsBase64ImageSource object`
223223
from line 269
269269
270270 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
271271
272 Union type for document source variants.
272 The source of the document data.
273273
274274 - `BetaManagedAgentsBase64DocumentSource object`
275275
from line 355
355355
356356 - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
357357
358 Rubric for grading the quality of an outcome.
358 How to grade the outcome. Text or file reference.
359359
360360 - `BetaManagedAgentsFileRubricParams object`
361361
from line 495
495495
496496 - `access: optional "read_write" or "read_only" or null`
497497
498 Access mode for an attached memory store.
498 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
499499
500500 - `"read_write"`
501501
from line 509
509509
510510- `schedule: optional BetaManagedAgentsScheduleParams or null`
511511
512 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
512 Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only).
513513
514514 - `type: "cron"`
515515
from line 543
543543
544544 - `agent: BetaManagedAgentsAgentReference`
545545
546 A resolved agent reference with a concrete version.
546 Reference to the agent this deployment runs, resolved to a concrete version.
547547
548548 - `type: "agent"`
549549
from line 555
555555
556556 - `archived_at: string or null`
557557
558 A timestamp in RFC 3339 format
558 Time the deployment was archived. Null if not archived.
559559
560560 format: date-time
561561
562562 - `created_at: string`
563563
564 A timestamp in RFC 3339 format
564 Time the deployment was created.
565565
566566 format: date-time
567567
from line 607
607607
608608 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
609609
610 Union type for image source variants.
610 The source of the image data.
611611
612612 - `BetaManagedAgentsBase64ImageSource object`
613613
from line 659
659659
660660 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
661661
662 Union type for document source variants.
662 The source of the document data.
663663
664664 - `BetaManagedAgentsBase64DocumentSource object`
665665
from line 745
745745
746746 - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`
747747
748 Rubric for grading the quality of an outcome.
748 How to grade the outcome. Text or file reference.
749749
750750 - `BetaManagedAgentsFileRubric object`
751751
from line 801
801801
802802 - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`
803803
804 Why a deployment is paused. Non-null exactly when `status` is `paused`.
804 Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise.
805805
806806 - `BetaManagedAgentsManualDeploymentPausedReason object`
807807
from line 817
817817
818818 - `error: BetaManagedAgentsDeploymentPausedReasonError`
819819
820 The error that triggered an auto-pause. Matches the failed run's `error.type`.
820 The failed run's error.
821821
822822 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
823823
from line 971
971971
972972 - `access: optional "read_write" or "read_only" or null`
973973
974 Access mode for an attached memory store.
974 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.
975975
976976 - `"read_write"`
977977
from line 983
983983
984984 - `schedule: BetaManagedAgentsSchedule or null`
985985
986 5-field POSIX cron schedule with computed runtime timestamps.
986 Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant.
987987
988988 - `type: "cron"`
989989
from line 1001
10011001
10021002 - `last_run_at: optional string or null`
10031003
1004 A timestamp in RFC 3339 format
1004 Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
10051005
10061006 format: date-time
10071007
from line 1011
10111011
10121012 - `status: BetaManagedAgentsDeploymentStatus`
10131013
1014 Lifecycle status of a deployment.
1014 Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set.
10151015
10161016 - `"active"`
10171017
from line 1023
10231023
10241024 - `updated_at: string`
10251025
1026 A timestamp in RFC 3339 format
1026 Time the deployment was last updated.
10271027
10281028 format: date-time
10291029
from line 1033
10331033
10341034 - `budget: optional BetaManagedAgentsBudgetLimit or null`
10351035
1036 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
1036 Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set.
10371037
10381038 - `type: "limit"`
10391039
10401040 - `max_list_cost: BetaMonetaryAmount`
10411041
1042 A monetary amount in a specific currency.
1042 Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.
10431043
10441044 - `amount: string`
10451045
from line 1057
10571057 -H 'anthropic-version: 2023-06-01' \
10581058 -H 'anthropic-beta: managed-agents-2026-04-01' \
10591059 -H "X-Api-Key: $ANTHROPIC_API_KEY" \
1060 -d '{}'
1060 -d '{
1061 "schedule": {
1062 "expression": "0 9 * * 1-5",
1063 "timezone": "America/Los_Angeles",
1064 "type": "cron"
1065 }
1066 }'
10611067```
10621068
10631069### Response (200)
api/beta/dreams Changed · +62 / -70 lines
from line 189
189189
190190 - `speed: optional "standard" or "fast" or null`
191191
192 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
192 How fast the model generates output for the dream. Defaults to `standard`.
193193
194 Dreams accept only `standard`.
195
194196 - `"standard"`
195197
196198 - `"fast"`
from line 251
249251
250252 - `archived_at: string or null`
251253
252 A timestamp in RFC 3339 format
254 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
253255
254256 format: date-time
255257
256258 - `created_at: string`
257259
258 A timestamp in RFC 3339 format
260 When the dream was created, in RFC 3339.
259261
262 Lists of dreams are sorted by this time, newest first.
263
260264 format: date-time
261265
262266 - `ended_at: string or null`
263267
264 A timestamp in RFC 3339 format
268 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
265269
266270 format: date-time
267271
268272 - `error: BetaDreamError or null`
269273
270 Failure detail for a Dream whose `status` is `failed`.
274 Why the dream failed, or `null` if `status` isn't `failed`.
271275
272276 - `type: string`
273277
from line 335
331335
332336 - `speed: optional "standard" or "fast"`
333337
334 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
338 How fast the model generates output for the dream. Always `standard`.
335339
336340 - `"standard"`
337341
from line 343
339343
340344 - `output_behavior: BetaOutputBehavior`
341345
342 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
346 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
343347
344348 - `BetaOutputBehaviorCreateNew object`
345349
from line 429
425429
426430 - `usage: BetaDreamUsage`
427431
428 The tokens that a dream has used so far.
432 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
429433
430 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
431
432 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
433
434434 - `cache_creation_input_tokens: number`
435435
436436 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 718
718718
719719 - `archived_at: string or null`
720720
721 A timestamp in RFC 3339 format
721 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
722722
723723 format: date-time
724724
725725 - `created_at: string`
726726
727 A timestamp in RFC 3339 format
727 When the dream was created, in RFC 3339.
728728
729 Lists of dreams are sorted by this time, newest first.
730
729731 format: date-time
730732
731733 - `ended_at: string or null`
732734
733 A timestamp in RFC 3339 format
735 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
734736
735737 format: date-time
736738
737739 - `error: BetaDreamError or null`
738740
739 Failure detail for a Dream whose `status` is `failed`.
741 Why the dream failed, or `null` if `status` isn't `failed`.
740742
741743 - `type: string`
742744
from line 802
800802
801803 - `speed: optional "standard" or "fast"`
802804
803 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
805 How fast the model generates output for the dream. Always `standard`.
804806
805807 - `"standard"`
806808
from line 810
808810
809811 - `output_behavior: BetaOutputBehavior`
810812
811 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
813 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
812814
813815 - `BetaOutputBehaviorCreateNew object`
814816
from line 896
894896
895897 - `usage: BetaDreamUsage`
896898
897 The tokens that a dream has used so far.
899 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
898900
899 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
900
901 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
902
903901 - `cache_creation_input_tokens: number`
904902
905903 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 1134
11361134
11371135 - `archived_at: string or null`
11381136
1139 A timestamp in RFC 3339 format
1137 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
11401138
11411139 format: date-time
11421140
11431141 - `created_at: string`
11441142
1145 A timestamp in RFC 3339 format
1143 When the dream was created, in RFC 3339.
11461144
1145 Lists of dreams are sorted by this time, newest first.
1146
11471147 format: date-time
11481148
11491149 - `ended_at: string or null`
11501150
1151 A timestamp in RFC 3339 format
1151 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
11521152
11531153 format: date-time
11541154
11551155 - `error: BetaDreamError or null`
11561156
1157 Failure detail for a Dream whose `status` is `failed`.
1157 Why the dream failed, or `null` if `status` isn't `failed`.
11581158
11591159 - `type: string`
11601160
from line 1218
12181218
12191219 - `speed: optional "standard" or "fast"`
12201220
1221 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
1221 How fast the model generates output for the dream. Always `standard`.
12221222
12231223 - `"standard"`
12241224
from line 1226
12261226
12271227 - `output_behavior: BetaOutputBehavior`
12281228
1229 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
1229 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
12301230
12311231 - `BetaOutputBehaviorCreateNew object`
12321232
from line 1312
13121312
13131313 - `usage: BetaDreamUsage`
13141314
1315 The tokens that a dream has used so far.
1315 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
13161316
1317 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
1318
1319 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
1320
13211317 - `cache_creation_input_tokens: number`
13221318
13231319 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 1539
15431539
15441540 - `archived_at: string or null`
15451541
1546 A timestamp in RFC 3339 format
1542 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
15471543
15481544 format: date-time
15491545
15501546 - `created_at: string`
15511547
1552 A timestamp in RFC 3339 format
1548 When the dream was created, in RFC 3339.
15531549
1550 Lists of dreams are sorted by this time, newest first.
1551
15541552 format: date-time
15551553
15561554 - `ended_at: string or null`
15571555
1558 A timestamp in RFC 3339 format
1556 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
15591557
15601558 format: date-time
15611559
15621560 - `error: BetaDreamError or null`
15631561
1564 Failure detail for a Dream whose `status` is `failed`.
1562 Why the dream failed, or `null` if `status` isn't `failed`.
15651563
15661564 - `type: string`
15671565
from line 1623
16251623
16261624 - `speed: optional "standard" or "fast"`
16271625
1628 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
1626 How fast the model generates output for the dream. Always `standard`.
16291627
16301628 - `"standard"`
16311629
from line 1631
16331631
16341632 - `output_behavior: BetaOutputBehavior`
16351633
1636 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
1634 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
16371635
16381636 - `BetaOutputBehaviorCreateNew object`
16391637
from line 1717
17191717
17201718 - `usage: BetaDreamUsage`
17211719
1722 The tokens that a dream has used so far.
1720 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
17231721
1724 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
1725
1726 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
1727
17281722 - `cache_creation_input_tokens: number`
17291723
17301724 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 1945
19511945
19521946 - `archived_at: string or null`
19531947
1954 A timestamp in RFC 3339 format
1948 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
19551949
19561950 format: date-time
19571951
19581952 - `created_at: string`
19591953
1960 A timestamp in RFC 3339 format
1954 When the dream was created, in RFC 3339.
19611955
1956 Lists of dreams are sorted by this time, newest first.
1957
19621958 format: date-time
19631959
19641960 - `ended_at: string or null`
19651961
1966 A timestamp in RFC 3339 format
1962 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
19671963
19681964 format: date-time
19691965
19701966 - `error: BetaDreamError or null`
19711967
1972 Failure detail for a Dream whose `status` is `failed`.
1968 Why the dream failed, or `null` if `status` isn't `failed`.
19731969
19741970 - `type: string`
19751971
from line 2029
20332029
20342030 - `speed: optional "standard" or "fast"`
20352031
2036 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
2032 How fast the model generates output for the dream. Always `standard`.
20372033
20382034 - `"standard"`
20392035
from line 2037
20412037
20422038 - `output_behavior: BetaOutputBehavior`
20432039
2044 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
2040 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
20452041
20462042 - `BetaOutputBehaviorCreateNew object`
20472043
from line 2123
21272123
21282124 - `usage: BetaDreamUsage`
21292125
2130 The tokens that a dream has used so far.
2126 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
21312127
2132 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
2133
2134 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
2135
21362128 - `cache_creation_input_tokens: number`
21372129
21382130 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 2225
22332225
22342226 - `archived_at: string or null`
22352227
2236 A timestamp in RFC 3339 format
2228 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
22372229
22382230 format: date-time
22392231
22402232 - `created_at: string`
22412233
2242 A timestamp in RFC 3339 format
2234 When the dream was created, in RFC 3339.
22432235
2236 Lists of dreams are sorted by this time, newest first.
2237
22442238 format: date-time
22452239
22462240 - `ended_at: string or null`
22472241
2248 A timestamp in RFC 3339 format
2242 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
22492243
22502244 format: date-time
22512245
22522246 - `error: BetaDreamError or null`
22532247
2254 Failure detail for a Dream whose `status` is `failed`.
2248 Why the dream failed, or `null` if `status` isn't `failed`.
22552249
22562250 - `type: string`
22572251
from line 2309
23152309
23162310 - `speed: optional "standard" or "fast"`
23172311
2318 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
2312 How fast the model generates output for the dream. Always `standard`.
23192313
23202314 - `"standard"`
23212315
from line 2317
23232317
23242318 - `output_behavior: BetaOutputBehavior`
23252319
2326 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
2320 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
23272321
23282322 - `BetaOutputBehaviorCreateNew object`
23292323
from line 2403
24092403
24102404 - `usage: BetaDreamUsage`
24112405
2412 The tokens that a dream has used so far.
2406 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
24132407
2414 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
2415
2416 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
2417
24182408 - `cache_creation_input_tokens: number`
24192409
24202410 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.
from line 2529
25392529
25402530 - `speed: optional "standard" or "fast"`
25412531
2542 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
2532 How fast the model generates output for the dream. Always `standard`.
25432533
25442534 - `"standard"`
25452535
from line 2553
25632553
25642554 - `speed: optional "standard" or "fast" or null`
25652555
2566 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
2556 How fast the model generates output for the dream. Defaults to `standard`.
25672557
2558 Dreams accept only `standard`.
2559
25682560 - `"standard"`
25692561
25702562 - `"fast"`
from line 2565
25732565
25742566- `BetaDreamOutput object`
25752567
2576 The memory store that holds a dream's result, as an entry in `outputs`.
2568 An entry in a dream's `outputs` that references the memory store holding its result.
25772569
25782570 - `type: "memory_store"`
25792571
api/beta/dreams/archive Changed · +9 / -11 lines
from line 151
151151
152152 - `archived_at: string or null`
153153
154 A timestamp in RFC 3339 format
154 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
155155
156156 format: date-time
157157
158158 - `created_at: string`
159159
160 A timestamp in RFC 3339 format
160 When the dream was created, in RFC 3339.
161161
162 Lists of dreams are sorted by this time, newest first.
163
162164 format: date-time
163165
164166 - `ended_at: string or null`
165167
166 A timestamp in RFC 3339 format
168 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
167169
168170 format: date-time
169171
170172 - `error: BetaDreamError or null`
171173
172 Failure detail for a Dream whose `status` is `failed`.
174 Why the dream failed, or `null` if `status` isn't `failed`.
173175
174176 - `type: string`
175177
from line 235
233235
234236 - `speed: optional "standard" or "fast"`
235237
236 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
238 How fast the model generates output for the dream. Always `standard`.
237239
238240 - `"standard"`
239241
from line 243
241243
242244 - `output_behavior: BetaOutputBehavior`
243245
244 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
246 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
245247
246248 - `BetaOutputBehaviorCreateNew object`
247249
from line 329
327329
328330 - `usage: BetaDreamUsage`
329331
330 The tokens that a dream has used so far.
331
332 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
333
334 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
332 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
335333
336334 - `cache_creation_input_tokens: number`
337335
api/beta/dreams/cancel Changed · +9 / -11 lines
from line 151
151151
152152 - `archived_at: string or null`
153153
154 A timestamp in RFC 3339 format
154 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
155155
156156 format: date-time
157157
158158 - `created_at: string`
159159
160 A timestamp in RFC 3339 format
160 When the dream was created, in RFC 3339.
161161
162 Lists of dreams are sorted by this time, newest first.
163
162164 format: date-time
163165
164166 - `ended_at: string or null`
165167
166 A timestamp in RFC 3339 format
168 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
167169
168170 format: date-time
169171
170172 - `error: BetaDreamError or null`
171173
172 Failure detail for a Dream whose `status` is `failed`.
174 Why the dream failed, or `null` if `status` isn't `failed`.
173175
174176 - `type: string`
175177
from line 235
233235
234236 - `speed: optional "standard" or "fast"`
235237
236 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
238 How fast the model generates output for the dream. Always `standard`.
237239
238240 - `"standard"`
239241
from line 243
241243
242244 - `output_behavior: BetaOutputBehavior`
243245
244 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
246 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
245247
246248 - `BetaOutputBehaviorCreateNew object`
247249
from line 329
327329
328330 - `usage: BetaDreamUsage`
329331
330 The tokens that a dream has used so far.
331
332 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
333
334 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
332 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
335333
336334 - `cache_creation_input_tokens: number`
337335
api/beta/dreams/create Changed · +12 / -12 lines
from line 187
187187
188188 - `speed: optional "standard" or "fast" or null`
189189
190 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
190 How fast the model generates output for the dream. Defaults to `standard`.
191191
192 Dreams accept only `standard`.
193
192194 - `"standard"`
193195
194196 - `"fast"`
from line 249
247249
248250 - `archived_at: string or null`
249251
250 A timestamp in RFC 3339 format
252 When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
251253
252254 format: date-time
253255
254256 - `created_at: string`
255257
256 A timestamp in RFC 3339 format
258 When the dream was created, in RFC 3339.
257259
260 Lists of dreams are sorted by this time, newest first.
261
258262 format: date-time
259263
260264 - `ended_at: string or null`
261265
262 A timestamp in RFC 3339 format
266 When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`.
263267
264268 format: date-time
265269
266270 - `error: BetaDreamError or null`
267271
268 Failure detail for a Dream whose `status` is `failed`.
272 Why the dream failed, or `null` if `status` isn't `failed`.
269273
270274 - `type: string`
271275
from line 333
329333
330334 - `speed: optional "standard" or "fast"`
331335
332 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
336 How fast the model generates output for the dream. Always `standard`.
333337
334338 - `"standard"`
335339
from line 341
337341
338342 - `output_behavior: BetaOutputBehavior`
339343
340 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.
344 Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior.
341345
342346 - `BetaOutputBehaviorCreateNew object`
343347
from line 427
423427
424428 - `usage: BetaDreamUsage`
425429
426 The tokens that a dream has used so far.
427
428 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.
429
430 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.
430 The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing.
431431
432432 - `cache_creation_input_tokens: number`
433433