Create Session changedapi/beta/sessions/create
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+267added
Lines−334removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits23to this page, all time
# Create Session ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create Session ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The whole hunk
from line 1, old and new numbered
/
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: Create Session
3url: https://platform.claude.com/docs/en/api/beta/sessions/create
4---
5
6## Create Session
7
8**post** `/v1/sessions`
1# Create Session
2
3**POST** `/v1/sessions`
94
105Create Session
116
12### Header Parameters
7## Headers
138
149- `"anthropic-beta": optional array of AnthropicBeta`
1510
from line 82
8782
8883 - `"mid-conversation-tool-changes-2026-07-01"`
8984
90### Body Parameters
85## Body parameters
9186
9287- `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams`
9388
from line 90
9590
9691 - `string`
9792
98 - `BetaManagedAgentsAgentParams object { id, type, version }`
93 - `BetaManagedAgentsAgentParams object`
9994
10095 Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
10196
from line 98
10398
10499 The `agent` ID.
105100
101 minLength: 1, maxLength: 128
102
106103 - `type: "agent"`
107104
108 - `"agent"`
109
110105 - `version: optional number`
111106
112107 The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
113108
114 - `BetaManagedAgentsAgentWithOverridesParams object { id, type, mcp_servers, 5 more }`
109 format: int32
110
111 - `BetaManagedAgentsAgentWithOverridesParams object`
115112
116113 Reference to an `agent` plus optional configuration overrides. Each provided field replaces the agent's value for the caller's use; the agent resource is unchanged.
117114
from line 116
119116
120117 The `agent` ID.
121118
119 minLength: 1, maxLength: 128
120
122121 - `type: "agent_with_overrides"`
123122
124 - `"agent_with_overrides"`
125
126123 - `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams`
127124
128125 Replacement MCP server list. Full replacement: the provided array becomes the MCP servers. Send an empty array to clear; omit to preserve the agent's servers.
from line 128
131128
132129 Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
133130
131 minLength: 1, maxLength: 255
132
134133 - `type: "url"`
135134
136 - `"url"`
137
138135 - `url: string`
139136
140137 Endpoint URL for the MCP server.
141138
139 maxLength: 2048
140
142141 - `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
143142
144143 Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model.
from line 208
209208
210209 - `string`
211210
212 - `BetaManagedAgentsModelConfigParams object { id, effort, inference_geo, speed }`
211 - `BetaManagedAgentsModelConfigParams object`
213212
214213 An object that defines additional configuration control over model use
215214
from line 236
237236
238237 - `"max"`
239238
240 - `BetaManagedAgentsEffortLow object { type }`
239 - `BetaManagedAgentsEffortLow object`
241240
242241 Low effort. Favors latency over reasoning depth.
243242
244243 - `type: "low"`
245244
246 - `"low"`
247
248 - `BetaManagedAgentsEffortMedium object { type }`
245 - `BetaManagedAgentsEffortMedium object`
249246
250247 Medium effort. Balances latency and reasoning depth.
251248
252249 - `type: "medium"`
253250
254 - `"medium"`
255
256 - `BetaManagedAgentsEffortHigh object { type }`
251 - `BetaManagedAgentsEffortHigh object`
257252
258253 High effort. Favors reasoning depth.
259254
260255 - `type: "high"`
261256
262 - `"high"`
263
264 - `BetaManagedAgentsEffortXhigh object { type }`
257 - `BetaManagedAgentsEffortXhigh object`
265258
266259 Extra-high effort. Not all models accept this level.
267260
268261 - `type: "xhigh"`
269262
270 - `"xhigh"`
271
272 - `BetaManagedAgentsEffortMax object { type }`
263 - `BetaManagedAgentsEffortMax object`
273264
274265 Maximum effort. Favors reasoning depth over latency.
275266
276267 - `type: "max"`
277268
278 - `"max"`
279
280269 - `inference_geo: optional string or null`
281270
282271 Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it.
from line 282
293282
294283 Replacement skill list. Full replacement: the provided array becomes the skills. Send an empty array to clear; omit to preserve the agent's skills.
295284
296 - `BetaManagedAgentsAnthropicSkillParams object { skill_id, type, version }`
285 - `BetaManagedAgentsAnthropicSkillParams object`
297286
298287 An Anthropic-managed skill.
299288
from line 290
301290
302291 Identifier of the Anthropic skill (e.g., "xlsx").
303292
293 minLength: 1, maxLength: 64
294
304295 - `type: "anthropic"`
305296
306 - `"anthropic"`
307
308297 - `version: optional string or null`
309298
310299 Version to pin. Defaults to latest if omitted.
311300
312 - `BetaManagedAgentsCustomSkillParams object { skill_id, type, version }`
301 minLength: 1, maxLength: 64
302
303 - `BetaManagedAgentsCustomSkillParams object`
313304
314305 A user-created custom skill.
315306
from line 308
317308
318309 Tagged ID of the custom skill (e.g., "skill_01XJ5...").
319310
311 minLength: 1, maxLength: 64
312
320313 - `type: "custom"`
321314
322 - `"custom"`
323
324315 - `version: optional string or null`
325316
326317 Version to pin. Defaults to latest if omitted.
327318
319 minLength: 1, maxLength: 64
320
328321 - `system: optional string or null`
329322
330323 Replacement system prompt. Up to 100,000 characters. Set to null to clear the agent's system prompt; omit to preserve it.
331324
325 maxLength: 100000
326
332327 - `tools: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams`
333328
334329 Replacement tool list. Full replacement: the provided array becomes the tool configuration. Send an empty array to clear; omit to preserve the agent's tools.
335330
336 - `BetaManagedAgentsAgentToolset20260401Params object { type, configs, default_config }`
331 - `BetaManagedAgentsAgentToolset20260401Params object`
337332
338333 Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.
339334
340335 - `type: "agent_toolset_20260401"`
341336
342 - `"agent_toolset_20260401"`
343
344337 - `configs: optional array of BetaManagedAgentsAgentToolConfigParams`
345338
346339 Per-tool configuration overrides.
347340
348 - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }`
341 - `BetaManagedAgentsBashToolConfigParams object`
349342
350343 Configuration override for the bash tool.
351344
from line 346
353346
354347 Must be "bash".
355348
356 - `"bash"`
357
358349 - `enabled: optional boolean or null`
359350
360351 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 354
363354
364355 Permission policy for tool execution.
365356
366 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
357 - `BetaManagedAgentsAlwaysAllowPolicy object`
367358
368359 Tool calls are automatically approved without user confirmation.
369360
370361 - `type: "always_allow"`
371362
372 - `"always_allow"`
373
374 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
363 - `BetaManagedAgentsAlwaysAskPolicy object`
375364
376365 Tool calls require user confirmation before execution.
377366
378367 - `type: "always_ask"`
379368
380 - `"always_ask"`
381
382369 - `type: optional "bash"`
383370
384 - `"bash"`
385
386 - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }`
371 - `BetaManagedAgentsEditToolConfigParams object`
387372
388373 Configuration override for the edit tool.
389374
from line 376
391376
392377 Must be "edit".
393378
394 - `"edit"`
395
396379 - `enabled: optional boolean or null`
397380
398381 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 384
401384
402385 Permission policy for tool execution.
403386
404 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
387 - `BetaManagedAgentsAlwaysAllowPolicy object`
405388
406389 Tool calls are automatically approved without user confirmation.
407390
408 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
391 - `BetaManagedAgentsAlwaysAskPolicy object`
409392
410393 Tool calls require user confirmation before execution.
411394
412395 - `type: optional "edit"`
413396
414 - `"edit"`
415
416 - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }`
397 - `BetaManagedAgentsReadToolConfigParams object`
417398
418399 Configuration override for the read tool.
419400
from line 402
421402
422403 Must be "read".
423404
424 - `"read"`
425
426405 - `enabled: optional boolean or null`
427406
428407 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 410
431410
432411 Permission policy for tool execution.
433412
434 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
413 - `BetaManagedAgentsAlwaysAllowPolicy object`
435414
436415 Tool calls are automatically approved without user confirmation.
437416
438 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
417 - `BetaManagedAgentsAlwaysAskPolicy object`
439418
440419 Tool calls require user confirmation before execution.
441420
442421 - `type: optional "read"`
443422
444 - `"read"`
445
446 - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }`
423 - `BetaManagedAgentsWriteToolConfigParams object`
447424
448425 Configuration override for the write tool.
449426
from line 428
451428
452429 Must be "write".
453430
454 - `"write"`
455
456431 - `enabled: optional boolean or null`
457432
458433 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 436
461436
462437 Permission policy for tool execution.
463438
464 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
439 - `BetaManagedAgentsAlwaysAllowPolicy object`
465440
466441 Tool calls are automatically approved without user confirmation.
467442
468 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
443 - `BetaManagedAgentsAlwaysAskPolicy object`
469444
470445 Tool calls require user confirmation before execution.
471446
472447 - `type: optional "write"`
473448
474 - `"write"`
475
476 - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }`
449 - `BetaManagedAgentsGlobToolConfigParams object`
477450
478451 Configuration override for the glob tool.
479452
from line 454
481454
482455 Must be "glob".
483456
484 - `"glob"`
485
486457 - `enabled: optional boolean or null`
487458
488459 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 462
491462
492463 Permission policy for tool execution.
493464
494 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
465 - `BetaManagedAgentsAlwaysAllowPolicy object`
495466
496467 Tool calls are automatically approved without user confirmation.
497468
498 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
469 - `BetaManagedAgentsAlwaysAskPolicy object`
499470
500471 Tool calls require user confirmation before execution.
501472
502473 - `type: optional "glob"`
503474
504 - `"glob"`
505
506 - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }`
475 - `BetaManagedAgentsGrepToolConfigParams object`
507476
508477 Configuration override for the grep tool.
509478
from line 480
511480
512481 Must be "grep".
513482
514 - `"grep"`
515
516483 - `enabled: optional boolean or null`
517484
518485 Whether this tool is enabled and available to Claude. Overrides the default_config setting.
from line 488
521488
522489 Permission policy for tool execution.
523490
524 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
491 - `BetaManagedAgentsAlwaysAllowPolicy object`
525492
526493 Tool calls are automatically approved without user confirmation.
527494
528 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
495 - `BetaManagedAgentsAlwaysAskPolicy object`
529496
530497 Tool calls require user confirmation before execution.
531498
532499 - `type: optional "grep"`
533500
534 - `"grep"`
535
536 - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }`
501 - `BetaManagedAgentsWebFetchToolConfigParams object`
537502
538503 Configuration override for the web_fetch tool.
539504
from line 506
541506
542507 Must be "web_fetch".
543508
544 - `"web_fetch"`
545
546509 - `allowed_domains: optional array of string`
547510
548511 Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.
from line 522
559522
560523 Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.
561524
525 format: int32
526
562527 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
563528
564529 Permission policy for tool execution.
565530
566 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
531 - `BetaManagedAgentsAlwaysAllowPolicy object`
567532
568533 Tool calls are automatically approved without user confirmation.
569534
570 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
535 - `BetaManagedAgentsAlwaysAskPolicy object`
571536
572537 Tool calls require user confirmation before execution.
573538
574539 - `type: optional "web_fetch"`
575540
576 - `"web_fetch"`
577
578 - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }`
541 - `BetaManagedAgentsWebSearchToolConfigParams object`
579542
580543 Configuration override for the web_search tool.
581544
from line 546
583546
584547 Must be "web_search".
585548
586 - `"web_search"`
587
588549 - `allowed_domains: optional array of string`
589550
590551 Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains.
from line 562
601562
602563 Permission policy for tool execution.
603564
604 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
565 - `BetaManagedAgentsAlwaysAllowPolicy object`
605566
606567 Tool calls are automatically approved without user confirmation.
607568
608 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
569 - `BetaManagedAgentsAlwaysAskPolicy object`
609570
610571 Tool calls require user confirmation before execution.
611572
612573 - `type: optional "web_search"`
613574
614 - `"web_search"`
615
616575 - `user_location: optional BetaManagedAgentsUserLocation or null`
617576
618577 Approximate user location for search result localization.
from line 580
621580
622581 Location precision. Only "approximate" is supported.
623582
624 - `"approximate"`
625
626583 - `city: optional string or null`
627584
628585 City name.
629586
587 minLength: 1, maxLength: 255
588
630589 - `country: optional string or null`
631590
632591 Two-letter ISO 3166-1 country code, uppercase.
from line 594
635594
636595 Region or state name.
637596
597 minLength: 1, maxLength: 255
598
638599 - `timezone: optional string or null`
639600
640601 IANA timezone identifier, e.g. "America/Los_Angeles".
641602
603 minLength: 1, maxLength: 255
604
642605 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
643606
644607 Default configuration for all tools in a toolset.
from line 614
651614
652615 Permission policy for tool execution.
653616
654 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
617 - `BetaManagedAgentsAlwaysAllowPolicy object`
655618
656619 Tool calls are automatically approved without user confirmation.
657620
658 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
621 - `BetaManagedAgentsAlwaysAskPolicy object`
659622
660623 Tool calls require user confirmation before execution.
661624
662 - `BetaManagedAgentsMCPToolsetParams object { mcp_server_name, type, configs, default_config }`
625 - `BetaManagedAgentsMCPToolsetParams object`
663626
664627 Configuration for tools from an MCP server defined in `mcp_servers`.
665628
from line 630
667630
668631 Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters.
669632
633 minLength: 1, maxLength: 255
634
670635 - `type: "mcp_toolset"`
671636
672 - `"mcp_toolset"`
673
674637 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams`
675638
676639 Per-tool configuration overrides.
from line 642
679642
680643 Name of the MCP tool to configure. 1-128 characters.
681644
645 minLength: 1, maxLength: 128
646
682647 - `enabled: optional boolean or null`
683648
684649 Whether this tool is enabled. Overrides the `default_config` setting.
from line 652
687652
688653 Permission policy for tool execution.
689654
690 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
655 - `BetaManagedAgentsAlwaysAllowPolicy object`
691656
692657 Tool calls are automatically approved without user confirmation.
693658
694 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
659 - `BetaManagedAgentsAlwaysAskPolicy object`
695660
696661 Tool calls require user confirmation before execution.
697662
from line 672
707672
708673 Permission policy for tool execution.
709674
710 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
675 - `BetaManagedAgentsAlwaysAllowPolicy object`
711676
712677 Tool calls are automatically approved without user confirmation.
713678
714 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
679 - `BetaManagedAgentsAlwaysAskPolicy object`
715680
716681 Tool calls require user confirmation before execution.
717682
718 - `BetaManagedAgentsCustomToolParams object { description, input_schema, name, type }`
683 - `BetaManagedAgentsCustomToolParams object`
719684
720685 A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event.
721686
from line 688
723688
724689 Description of what the tool does, shown to the agent to help it decide when to use the tool.
725690
691 minLength: 1
692
726693 - `input_schema: BetaManagedAgentsCustomToolInputSchema`
727694
728695 JSON Schema for custom tool input parameters.
729696
730697 - `type: "object"`
731698
732 - `"object"`
733
734699 - `properties: optional map[unknown] or null`
735700
736701 - `required: optional array of string or null`
from line 704
739704
740705 Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.
741706
707 minLength: 1, maxLength: 128
708
742709 - `type: "custom"`
743710
744 - `"custom"`
745
746711 - `version: optional number`
747712
748713 The specific `agent` version to use. Omit to use the latest version.
749714
715 format: int32
716
750717- `environment_id: string`
751718
752719 ID of the `environment` defining the container configuration for this session.
753720
721 minLength: 1, maxLength: 128
722
754723- `budget: optional BetaManagedAgentsBudgetLimit`
755724
756725 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
from line 736
767736
768737 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.
769738
770 - `"USD"`
771
772739 - `type: "limit"`
773740
774 - `"limit"`
775
776741- `initial_events: optional array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams`
777742
778743 Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events.
779744
780 - `BetaManagedAgentsUserMessageEventParams object { content, type }`
745 - `BetaManagedAgentsUserMessageEventParams object`
781746
782747 Parameters for sending a user message to the session.
783748
from line 750
785750
786751 Array of content blocks for the user message.
787752
788 - `BetaManagedAgentsTextBlock object { text, type }`
753 - `BetaManagedAgentsTextBlock object`
789754
790755 Regular text content.
791756
from line 758
793758
794759 The text content.
795760
761 minLength: 1
762
796763 - `type: "text"`
797764
798 - `"text"`
799
800 - `BetaManagedAgentsImageBlock object { source, type }`
765 - `BetaManagedAgentsImageBlock object`
801766
802767 Image content specified directly as base64 data or as a reference via a URL.
803768
from line 770
805770
806771 Union type for image source variants.
807772
808 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
773 - `BetaManagedAgentsBase64ImageSource object`
809774
810775 Base64-encoded image data.
811776
from line 778
813778
814779 Base64-encoded image data.
815780
781 minLength: 1
782
816783 - `media_type: string`
817784
818785 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
819786
787 minLength: 1
788
820789 - `type: "base64"`
821790
822 - `"base64"`
823
824 - `BetaManagedAgentsURLImageSource object { type, url }`
791 - `BetaManagedAgentsURLImageSource object`
825792
826793 Image referenced by URL.
827794
828795 - `type: "url"`
829796
830 - `"url"`
831
832797 - `url: string`
833798
834799 URL of the image to fetch.
835800
836 - `BetaManagedAgentsFileImageSource object { file_id, type }`
801 minLength: 1
802
803 - `BetaManagedAgentsFileImageSource object`
837804
838805 Image referenced by file ID.
839806
from line 808
841808
842809 ID of a previously uploaded file.
843810
811 minLength: 1
812
844813 - `type: "file"`
845814
846 - `"file"`
847
848815 - `type: "image"`
849816
850 - `"image"`
851
852 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
817 - `BetaManagedAgentsDocumentBlock object`
853818
854819 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
855820
from line 822
857822
858823 Union type for document source variants.
859824
860 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
825 - `BetaManagedAgentsBase64DocumentSource object`
861826
862827 Base64-encoded document data.
863828
from line 830
865830
866831 Base64-encoded document data.
867832
833 minLength: 1
834
868835 - `media_type: string`
869836
870837 MIME type of the document (e.g., "application/pdf").
871838
839 minLength: 1
840
872841 - `type: "base64"`
873842
874 - `"base64"`
875
876 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
843 - `BetaManagedAgentsPlainTextDocumentSource object`
877844
878845 Plain text document content.
879846
from line 848
881848
882849 The plain text content.
883850
851 minLength: 1
852
884853 - `media_type: "text/plain"`
885854
886855 MIME type of the text content. Must be "text/plain".
887856
888 - `"text/plain"`
889
890857 - `type: "text"`
891858
892 - `"text"`
893
894 - `BetaManagedAgentsURLDocumentSource object { type, url }`
859 - `BetaManagedAgentsURLDocumentSource object`
895860
896861 Document referenced by URL.
897862
898863 - `type: "url"`
899864
900 - `"url"`
901
902865 - `url: string`
903866
904867 URL of the document to fetch.
905868
906 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`
869 minLength: 1
870
871 - `BetaManagedAgentsFileDocumentSource object`
907872
908873 Document referenced by file ID.
909874
from line 876
911876
912877 ID of a previously uploaded file.
913878
879 minLength: 1
880
914881 - `type: "file"`
915882
916 - `"file"`
917
918883 - `type: "document"`
919884
920 - `"document"`
921
922885 - `context: optional string or null`
923886
924887 Additional context about the document for the model.
from line 890
927890
928891 The title of the document.
929892
930 - `BetaManagedAgentsRedactedBlock object { type }`
893 - `BetaManagedAgentsRedactedBlock object`
931894
932895 Placeholder for content withheld by Anthropic model policy.
933896
934897 - `type: "redacted"`
935898
936 - `"redacted"`
937
938899 - `type: "user.message"`
939900
940 - `"user.message"`
941
942 - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`
901 - `BetaManagedAgentsUserDefineOutcomeEventParams object`
943902
944903 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
945904
from line 910
951910
952911 Rubric for grading the quality of an outcome.
953912
954 - `BetaManagedAgentsFileRubricParams object { file_id, type }`
913 - `BetaManagedAgentsFileRubricParams object`
955914
956915 Rubric referenced by a file uploaded via the Files API.
957916
from line 920
961920
962921 - `type: "file"`
963922
964 - `"file"`
965
966 - `BetaManagedAgentsTextRubricParams object { content, type }`
923 - `BetaManagedAgentsTextRubricParams object`
967924
968925 Rubric content provided inline as text.
969926
from line 928
971928
972929 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.
973930
931 maxLength: 262144
932
974933 - `type: "text"`
975934
976 - `"text"`
977
978935 - `type: "user.define_outcome"`
979936
980 - `"user.define_outcome"`
981
982937 - `max_iterations: optional number or null`
983938
984939 Eval→revision cycles before giving up. Default 3, max 20.
985940
941 format: int32
942
986943- `metadata: optional map[string]`
987944
988945 Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
from line 948
991948
992949 Resources (e.g. repositories, files) to mount into the session's container.
993950
994 - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }`
951 - `BetaManagedAgentsGitHubRepositoryResourceParams object`
995952
996953 Mount a GitHub repository into the session's container.
997954
from line 956
999956
1000957 GitHub authorization token used to clone the repository.
1001958
959 minLength: 1, maxLength: 4096
960
1002961 - `type: "github_repository"`
1003962
1004 - `"github_repository"`
1005
1006963 - `url: string`
1007964
1008965 Github URL of the repository
1009966
967 minLength: 1, maxLength: 2048
968
1010969 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`
1011970
1012971 Branch or commit to check out. Defaults to the repository's default branch.
1013972
1014 - `BetaManagedAgentsBranchCheckout object { name, type }`
973 - `BetaManagedAgentsBranchCheckout object`
1015974
1016975 - `name: string`
1017976
1018977 Branch name to check out.
1019978
979 minLength: 1, maxLength: 255
980
1020981 - `type: "branch"`
1021982
1022 - `"branch"`
1023
1024 - `BetaManagedAgentsCommitCheckout object { sha, type }`
983 - `BetaManagedAgentsCommitCheckout object`
1025984
1026985 - `sha: string`
1027986
1028987 Full commit SHA to check out.
1029988
989 minLength: 7, maxLength: 64
990
1030991 - `type: "commit"`
1031992
1032 - `"commit"`
1033
1034993 - `mount_path: optional string or null`
1035994
1036995 Mount path in the container. Defaults to `/workspace/<repo-name>`.
1037996
1038 - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }`
997 minLength: 1, maxLength: 4096
998
999 - `BetaManagedAgentsFileResourceParams object`
10391000
10401001 Mount a file uploaded via the Files API into the session.
10411002
from line 1004
10431004
10441005 ID of a previously uploaded file.
10451006
1007 minLength: 1, maxLength: 128
1008
10461009 - `type: "file"`
10471010
1048 - `"file"`
1049
10501011 - `mount_path: optional string or null`
10511012
10521013 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
10531014
1054 - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }`
1015 minLength: 1, maxLength: 4096
1016
1017 - `BetaManagedAgentsMemoryStoreResourceParam object`
10551018
10561019 Parameters for attaching a memory store to an agent session.
10571020
from line 1024
10611024
10621025 - `type: "memory_store"`
10631026
1064 - `"memory_store"`
1065
10661027 - `access: optional "read_write" or "read_only" or null`
10671028
10681029 Access mode for an attached memory store.
from line 1036
10751036
10761037 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
10771038
1039 maxLength: 4096
1040
10781041- `title: optional string or null`
10791042
10801043 Human-readable session title.
10811044
1045 maxLength: 500
1046
10821047- `vault_ids: optional array of string`
10831048
10841049 Vault IDs for stored credentials the agent can use during the session.
10851050
1086### Returns
1087
1088- `BetaManagedAgentsSession object { id, agent, archived_at, 14 more }`
1051## Returns
1052
1053- `BetaManagedAgentsSession object`
10891054
10901055 A Managed Agents `session`.
10911056
from line 1070
11051070
11061071 - `type: "url"`
11071072
1108 - `"url"`
1109
11101073 - `url: string`
11111074
11121075 - `model: BetaManagedAgentsModelConfig`
from line 1146
11831146
11841147 How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes.
11851148
1186 - `BetaManagedAgentsEffortLow object { type }`
1149 - `BetaManagedAgentsEffortLow object`
11871150
11881151 Low effort. Favors latency over reasoning depth.
11891152
11901153 - `type: "low"`
11911154
1192 - `"low"`
1193
1194 - `BetaManagedAgentsEffortMedium object { type }`
1155 - `BetaManagedAgentsEffortMedium object`
11951156
11961157 Medium effort. Balances latency and reasoning depth.
11971158
11981159 - `type: "medium"`
11991160
1200 - `"medium"`
1201
1202 - `BetaManagedAgentsEffortHigh object { type }`
1161 - `BetaManagedAgentsEffortHigh object`
12031162
12041163 High effort. Favors reasoning depth.
12051164
12061165 - `type: "high"`
12071166
1208 - `"high"`
1209
1210 - `BetaManagedAgentsEffortXhigh object { type }`
1167 - `BetaManagedAgentsEffortXhigh object`
12111168
12121169 Extra-high effort. Not all models accept this level.
12131170
12141171 - `type: "xhigh"`
12151172
1216 - `"xhigh"`
1217
1218 - `BetaManagedAgentsEffortMax object { type }`
1173 - `BetaManagedAgentsEffortMax object`
12191174
12201175 Maximum effort. Favors reasoning depth over latency.
12211176
12221177 - `type: "max"`
12231178
1224 - `"max"`
1225
12261179 - `inference_geo: optional string`
12271180
12281181 Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
from line 1196
12431196
12441197 Full `agent` definitions the coordinator may spawn as session threads.
12451198
1246 - `BetaManagedAgentsSessionThreadAgent object { id, description, mcp_servers, 7 more }`
1199 - `BetaManagedAgentsSessionThreadAgent object`
12471200
12481201 Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`.
12491202
from line 1220
12671220
12681221 - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
12691222
1270 - `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
1223 - `BetaManagedAgentsAnthropicSkill object`
12711224
12721225 A resolved Anthropic-managed skill.
12731226
from line 1228
12751228
12761229 - `type: "anthropic"`
12771230
1278 - `"anthropic"`
1279
12801231 - `version: string`
12811232
1282 - `BetaManagedAgentsCustomSkill object { skill_id, type, version }`
1233 - `BetaManagedAgentsCustomSkill object`
12831234
12841235 A resolved user-created custom skill.
12851236
from line 1238
12871238
12881239 - `type: "custom"`
12891240
1290 - `"custom"`
1291
12921241 - `version: string`
12931242
12941243 - `system: string or null`
12951244
12961245 - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool`
12971246
1298 - `BetaManagedAgentsAgentToolset20260401 object { configs, default_config, type }`
1247 - `BetaManagedAgentsAgentToolset20260401 object`
12991248
13001249 - `configs: array of BetaManagedAgentsAgentToolConfig`
13011250
1302 - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }`
1251 - `BetaManagedAgentsBashToolConfig object`
13031252
13041253 Configuration for the bash tool.
13051254
from line 1256
13071256
13081257 - `name: "bash"`
13091258
1310 - `"bash"`
1311
13121259 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
13131260
13141261 Permission policy for tool execution.
13151262
1316 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1263 - `BetaManagedAgentsAlwaysAllowPolicy object`
13171264
13181265 Tool calls are automatically approved without user confirmation.
13191266
13201267 - `type: "always_allow"`
13211268
1322 - `"always_allow"`
1323
1324 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1269 - `BetaManagedAgentsAlwaysAskPolicy object`
13251270
13261271 Tool calls require user confirmation before execution.
13271272
13281273 - `type: "always_ask"`
13291274
1330 - `"always_ask"`
1331
13321275 - `type: "bash"`
13331276
1334 - `"bash"`
1335
1336 - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }`
1277 - `BetaManagedAgentsEditToolConfig object`
13371278
13381279 Configuration for the edit tool.
13391280
from line 1282
13411282
13421283 - `name: "edit"`
13431284
1344 - `"edit"`
1345
13461285 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
13471286
13481287 Permission policy for tool execution.
13491288
1350 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1289 - `BetaManagedAgentsAlwaysAllowPolicy object`
13511290
13521291 Tool calls are automatically approved without user confirmation.
13531292
1354 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1293 - `BetaManagedAgentsAlwaysAskPolicy object`
13551294
13561295 Tool calls require user confirmation before execution.
13571296
13581297 - `type: "edit"`
13591298
1360 - `"edit"`
1361
1362 - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }`
1299 - `BetaManagedAgentsReadToolConfig object`
13631300
13641301 Configuration for the read tool.
13651302
from line 1304
13671304
13681305 - `name: "read"`
13691306
1370 - `"read"`
1371
13721307 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
13731308
13741309 Permission policy for tool execution.
13751310
1376 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1311 - `BetaManagedAgentsAlwaysAllowPolicy object`
13771312
13781313 Tool calls are automatically approved without user confirmation.
13791314
1380 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1315 - `BetaManagedAgentsAlwaysAskPolicy object`
13811316
13821317 Tool calls require user confirmation before execution.
13831318
13841319 - `type: "read"`
13851320
1386 - `"read"`
1387
1388 - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }`
1321 - `BetaManagedAgentsWriteToolConfig object`
13891322
13901323 Configuration for the write tool.
13911324
from line 1326
13931326
13941327 - `name: "write"`
13951328
1396 - `"write"`
1397
13981329 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
13991330
14001331 Permission policy for tool execution.
14011332
1402 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1333 - `BetaManagedAgentsAlwaysAllowPolicy object`
14031334
14041335 Tool calls are automatically approved without user confirmation.
14051336
1406 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1337 - `BetaManagedAgentsAlwaysAskPolicy object`
14071338
14081339 Tool calls require user confirmation before execution.
14091340
14101341 - `type: "write"`
14111342
1412 - `"write"`
1413
1414 - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }`
1343 - `BetaManagedAgentsGlobToolConfig object`
14151344
14161345 Configuration for the glob tool.
14171346
from line 1348
14191348
14201349 - `name: "glob"`
14211350
1422 - `"glob"`
1423
14241351 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
14251352
14261353 Permission policy for tool execution.
14271354
1428 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1355 - `BetaManagedAgentsAlwaysAllowPolicy object`
14291356
14301357 Tool calls are automatically approved without user confirmation.
14311358
1432 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1359 - `BetaManagedAgentsAlwaysAskPolicy object`
14331360
14341361 Tool calls require user confirmation before execution.
14351362
14361363 - `type: "glob"`
14371364
1438 - `"glob"`
1439
1440 - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }`
1365 - `BetaManagedAgentsGrepToolConfig object`
14411366
14421367 Configuration for the grep tool.
14431368
from line 1370
14451370
14461371 - `name: "grep"`
14471372
1448 - `"grep"`
1449
14501373 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
14511374
14521375 Permission policy for tool execution.
14531376
1454 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1377 - `BetaManagedAgentsAlwaysAllowPolicy object`
14551378
14561379 Tool calls are automatically approved without user confirmation.
14571380
1458 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1381 - `BetaManagedAgentsAlwaysAskPolicy object`
14591382
14601383 Tool calls require user confirmation before execution.
14611384
14621385 - `type: "grep"`
14631386
1464 - `"grep"`
1465
1466 - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }`
1387 - `BetaManagedAgentsWebFetchToolConfig object`
14671388
14681389 Configuration for the web_fetch tool.
14691390
from line 1392
14711392
14721393 - `name: "web_fetch"`
14731394
1474 - `"web_fetch"`
1475
14761395 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
14771396
14781397 Permission policy for tool execution.
14791398
1480 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1399 - `BetaManagedAgentsAlwaysAllowPolicy object`
14811400
14821401 Tool calls are automatically approved without user confirmation.
14831402
1484 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1403 - `BetaManagedAgentsAlwaysAskPolicy object`
14851404
14861405 Tool calls require user confirmation before execution.
14871406
14881407 - `type: "web_fetch"`
14891408
1490 - `"web_fetch"`
1491
14921409 - `allowed_domains: optional array of string`
14931410
14941411 - `blocked_domains: optional array of string`
14951412
14961413 - `max_content_tokens: optional number or null`
14971414
1498 - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }`
1415 format: int32
1416
1417 - `BetaManagedAgentsWebSearchToolConfig object`
14991418
15001419 Configuration for the web_search tool.
15011420
from line 1422
15031422
15041423 - `name: "web_search"`
15051424
1506 - `"web_search"`
1507
15081425 - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy`
15091426
15101427 Permission policy for tool execution.
15111428
1512 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1429 - `BetaManagedAgentsAlwaysAllowPolicy object`
15131430
15141431 Tool calls are automatically approved without user confirmation.
15151432
1516 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1433 - `BetaManagedAgentsAlwaysAskPolicy object`
15171434
15181435 Tool calls require user confirmation before execution.
15191436
15201437 - `type: "web_search"`
15211438
1522 - `"web_search"`
1523
15241439 - `allowed_domains: optional array of string`
15251440
15261441 - `blocked_domains: optional array of string`
from line 1448
15331448
15341449 Location precision. Only "approximate" is supported.
15351450
1536 - `"approximate"`
1537
15381451 - `city: optional string or null`
15391452
15401453 City name.
15411454
1455 minLength: 1, maxLength: 255
1456
15421457 - `country: optional string or null`
15431458
15441459 Two-letter ISO 3166-1 country code, uppercase.
from line 1462
15471462
15481463 Region or state name.
15491464
1465 minLength: 1, maxLength: 255
1466
15501467 - `timezone: optional string or null`
15511468
15521469 IANA timezone identifier, e.g. "America/Los_Angeles".
15531470
1471 minLength: 1, maxLength: 255
1472
15541473 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
15551474
15561475 Resolved default configuration for agent tools.
from line 1480
15611480
15621481 Permission policy for tool execution.
15631482
1564 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1483 - `BetaManagedAgentsAlwaysAllowPolicy object`
15651484
15661485 Tool calls are automatically approved without user confirmation.
15671486
1568 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1487 - `BetaManagedAgentsAlwaysAskPolicy object`
15691488
15701489 Tool calls require user confirmation before execution.
15711490
15721491 - `type: "agent_toolset_20260401"`
15731492
1574 - `"agent_toolset_20260401"`
1575
1576 - `BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }`
1493 - `BetaManagedAgentsMCPToolset object`
15771494
15781495 - `configs: array of BetaManagedAgentsMCPToolConfig`
15791496
from line 1502
15851502
15861503 Permission policy for tool execution.
15871504
1588 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1505 - `BetaManagedAgentsAlwaysAllowPolicy object`
15891506
15901507 Tool calls are automatically approved without user confirmation.
15911508
1592 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1509 - `BetaManagedAgentsAlwaysAskPolicy object`
15931510
15941511 Tool calls require user confirmation before execution.
15951512
from line 1520
16031520
16041521 Permission policy for tool execution.
16051522
1606 - `BetaManagedAgentsAlwaysAllowPolicy object { type }`
1523 - `BetaManagedAgentsAlwaysAllowPolicy object`
16071524
16081525 Tool calls are automatically approved without user confirmation.
16091526
1610 - `BetaManagedAgentsAlwaysAskPolicy object { type }`
1527 - `BetaManagedAgentsAlwaysAskPolicy object`
16111528
16121529 Tool calls require user confirmation before execution.
16131530
from line 1532
16151532
16161533 - `type: "mcp_toolset"`
16171534
1618 - `"mcp_toolset"`
1619
1620 - `BetaManagedAgentsCustomTool object { description, input_schema, name, type }`
1535 - `BetaManagedAgentsCustomTool object`
16211536
16221537 A custom tool as returned in API responses.
16231538
from line 1544
16291544
16301545 - `type: "object"`
16311546
1632 - `"object"`
1633
16341547 - `properties: optional map[unknown] or null`
16351548
16361549 - `required: optional array of string or null`
from line 1552
16391552
16401553 - `type: "custom"`
16411554
1642 - `"custom"`
1643
16441555 - `type: "agent"`
16451556
1646 - `"agent"`
1647
16481557 - `version: number`
16491558
1650 - `BetaManagedAgentsAdvisor object { model, type }`
1559 format: int32
1560
1561 - `BetaManagedAgentsAdvisor object`
16511562
16521563 Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
16531564
from line 1568
16571568
16581569 - `type: "advisor"`
16591570
1660 - `"advisor"`
1661
16621571 - `type: "coordinator"`
16631572
1664 - `"coordinator"`
1665
16661573 - `name: string`
16671574
16681575 - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill`
16691576
1670 - `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
1577 - `BetaManagedAgentsAnthropicSkill object`
16711578
16721579 A resolved Anthropic-managed skill.
16731580
1674 - `BetaManagedAgentsCustomSkill object { skill_id, type, version }`
1581 - `BetaManagedAgentsCustomSkill object`
16751582
16761583 A resolved user-created custom skill.
16771584
from line 1586
16791586
16801587 - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool`
16811588
1682 - `BetaManagedAgentsAgentToolset20260401 object { configs, default_config, type }`
1683
1684 - `BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }`
1685
1686 - `BetaManagedAgentsCustomTool object { description, input_schema, name, type }`
1589 - `BetaManagedAgentsAgentToolset20260401 object`
1590
1591 - `BetaManagedAgentsMCPToolset object`
1592
1593 - `BetaManagedAgentsCustomTool object`
16871594
16881595 A custom tool as returned in API responses.
16891596
16901597 - `type: "agent"`
16911598
1692 - `"agent"`
1693
16941599 - `version: number`
16951600
1601 format: int32
1602
16961603 - `archived_at: string or null`
16971604
16981605 A timestamp in RFC 3339 format
16991606
1607 format: date-time
1608
17001609 - `budget: BetaManagedAgentsBudgetLimit or null`
17011610
17021611 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
from line 1622
17131622
17141623 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.
17151624
1716 - `"USD"`
1717
17181625 - `type: "limit"`
17191626
1720 - `"limit"`
1721
17221627 - `created_at: string`
17231628
17241629 A timestamp in RFC 3339 format
17251630
1631 format: date-time
1632
17261633 - `environment_id: string`
17271634
17281635 - `metadata: map[string]`
from line 1642
17351642
17361643 A timestamp in RFC 3339 format
17371644
1645 format: date-time
1646
17381647 - `description: string`
17391648
17401649 What the agent should produce.
from line 1656
17471656
17481657 0-indexed revision cycle the outcome is currently on.
17491658
1659 format: int32
1660
17501661 - `outcome_id: string`
17511662
17521663 Server-generated outc_ ID for this outcome.
from line 1668
17571668
17581669 - `type: "outcome_evaluation"`
17591670
1760 - `"outcome_evaluation"`
1761
17621671 - `resources: array of BetaManagedAgentsSessionResource`
17631672
1764 - `BetaManagedAgentsGitHubRepositoryResource object { id, created_at, mount_path, 4 more }`
1673 - `BetaManagedAgentsGitHubRepositoryResource object`
17651674
17661675 - `id: string`
17671676
from line 1678
17691678
17701679 A timestamp in RFC 3339 format
17711680
1681 format: date-time
1682
17721683 - `mount_path: string`
17731684
17741685 - `type: "github_repository"`
17751686
1776 - `"github_repository"`
1777
17781687 - `updated_at: string`
17791688
17801689 A timestamp in RFC 3339 format
17811690
1691 format: date-time
1692
17821693 - `url: string`
17831694
17841695 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`
17851696
1786 - `BetaManagedAgentsBranchCheckout object { name, type }`
1697 - `BetaManagedAgentsBranchCheckout object`
17871698
17881699 - `name: string`
17891700
17901701 Branch name to check out.
17911702
1703 minLength: 1, maxLength: 255
1704
17921705 - `type: "branch"`
17931706
1794 - `"branch"`
1795
1796 - `BetaManagedAgentsCommitCheckout object { sha, type }`
1707 - `BetaManagedAgentsCommitCheckout object`
17971708
17981709 - `sha: string`
17991710
18001711 Full commit SHA to check out.
18011712
1713 minLength: 7, maxLength: 64
1714
18021715 - `type: "commit"`
18031716
1804 - `"commit"`
1805
1806 - `BetaManagedAgentsFileResource object { id, created_at, file_id, 3 more }`
1717 - `BetaManagedAgentsFileResource object`
18071718
18081719 - `id: string`
18091720
from line 1722
18111722
18121723 A timestamp in RFC 3339 format
18131724
1725 format: date-time
1726
18141727 - `file_id: string`
18151728
18161729 - `mount_path: string`
18171730
18181731 - `type: "file"`
18191732
1820 - `"file"`
1821
18221733 - `updated_at: string`
18231734
18241735 A timestamp in RFC 3339 format
18251736
1826 - `BetaManagedAgentsMemoryStoreResource object { memory_store_id, type, access, 4 more }`
1737 format: date-time
1738
1739 - `BetaManagedAgentsMemoryStoreResource object`
18271740
18281741 A memory store attached to an agent session.
18291742
from line 1746
18331746
18341747 - `type: "memory_store"`
18351748
1836 - `"memory_store"`
1837
18381749 - `access: optional "read_write" or "read_only" or null`
18391750
18401751 Access mode for an attached memory store.
from line 1762
18511762
18521763 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
18531764
1765 maxLength: 4096
1766
18541767 - `mount_path: optional string or null`
18551768
18561769 Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only.
from line 1780
18671780
18681781 Cumulative time in seconds the session spent in running status. Excludes idle time.
18691782
1783 format: double
1784
18701785 - `duration_seconds: optional number`
18711786
18721787 Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update.
18731788
1789 format: double
1790
18741791 - `status: "rescheduling" or "running" or "idle" or "terminated"`
18751792
18761793 SessionStatus enum
from line 1804
18871804
18881805 - `type: "session"`
18891806
1890 - `"session"`
1891
18921807 - `updated_at: string`
18931808
18941809 A timestamp in RFC 3339 format
18951810
1811 format: date-time
1812
18961813 - `usage: BetaManagedAgentsSessionUsage`
18971814
18981815 Cumulative token usage for a session across all turns.
from line 1818
19011818
19021819 Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on.
19031820
1821 format: double
1822
19041823 - `cache_creation: optional BetaManagedAgentsCacheCreationUsage`
19051824
19061825 Prompt-cache creation token usage broken down by cache lifetime.
from line 1828
19091828
19101829 Tokens used to create 1-hour ephemeral cache entries.
19111830
1831 format: int32
1832
19121833 - `ephemeral_5m_input_tokens: optional number`
19131834
19141835 Tokens used to create 5-minute ephemeral cache entries.
19151836
1837 format: int32
1838
19161839 - `cache_read_input_tokens: optional number`
19171840
19181841 Total tokens read from prompt cache.
19191842
1843 format: int32
1844
19201845 - `input_tokens: optional number`
19211846
19221847 Total input tokens consumed across all turns.
19231848
1849 format: int32
1850
19241851 - `list_cost: optional BetaMonetaryAmount or null`
19251852
19261853 A monetary amount in a specific currency.
from line 1856
19291856
19301857 Total output tokens generated across all turns.
19311858
1859 format: int32
1860
19321861 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null`
19331862
19341863 Cumulative count of server-executed tool invocations, broken down by tool.
from line 1866
19371866
19381867 Number of server-executed web fetch requests.
19391868
1869 format: int32
1870
19401871 - `web_search_requests: optional number`
19411872
19421873 Number of server-executed web search requests.
19431874
1875 format: int32
1876
19441877 - `vault_ids: array of string`
19451878
19461879 Vault IDs attached to the session at creation. Empty when no vaults were supplied.
from line 1882
19491882
19501883 Deployment ID when the session was created from a deployment reference. Null otherwise.
19511884
1952### Example
1953
1954```http
1885## Example
1886
1887```bash
19551888curl https://api.anthropic.com/v1/sessions \
19561889 -H 'Content-Type: application/json' \
19571890 -H 'anthropic-version: 2023-06-01' \
from line 1897
19641897 }'
19651898```
19661899
1967#### Response
1900### Response (200)
19681901
19691902```json
19701903{
19711904
No line in this hunk matches that.