from line 1
1---
2title: Update Deployment
3url: https://platform.claude.com/docs/en/api/beta/deployments/update
4---
1# Update Deployment
52
6## Update Deployment
3**POST** `/v1/deployments/{deployment_id}`
74
8**post** `/v1/deployments/{deployment_id}`
9
105Update Deployment
116
12### Path Parameters
7## Path parameters
138
149- `deployment_id: string`
1510
16### Header Parameters
11## Headers
1712
1813- `"anthropic-beta": optional array of AnthropicBeta`
1914
from line 86
9186
9287 - `"mid-conversation-tool-changes-2026-07-01"`
9388
94### Body Parameters
89## Body parameters
9590
9691- `agent: optional string or BetaManagedAgentsAgentParams`
9792
from line 94
9994
10095 - `string`
10196
102 - `BetaManagedAgentsAgentParams object { id, type, version }`
97 - `BetaManagedAgentsAgentParams object`
10398
10499 Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
105100
from line 102
107102
108103 The `agent` ID.
109104
105 minLength: 1, maxLength: 128
106
110107 - `type: "agent"`
111108
112 - `"agent"`
113
114109 - `version: optional number`
115110
116111 The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
117112
113 format: int32
114
118115- `budget: optional BetaManagedAgentsBudgetLimit or null`
119116
120117 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
from line 128
131128
132129 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.
133130
134 - `"USD"`
135
136131 - `type: "limit"`
137132
138 - `"limit"`
139
140133- `description: optional string or null`
141134
142135 Description. Omit to preserve; send empty string or null to clear.
143136
137 maxLength: 2048
138
144139- `environment_id: optional string`
145140
146141 ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.
147142
143 maxLength: 128
144
148145- `initial_events: optional array of BetaManagedAgentsDeploymentInitialEventParams`
149146
150147 Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.
151148
152 - `BetaManagedAgentsUserMessageEventParams object { content, type }`
149 - `BetaManagedAgentsUserMessageEventParams object`
153150
154151 Parameters for sending a user message to the session.
155152
from line 154
157154
158155 Array of content blocks for the user message.
159156
160 - `BetaManagedAgentsTextBlock object { text, type }`
157 - `BetaManagedAgentsTextBlock object`
161158
162159 Regular text content.
163160
from line 162
165162
166163 The text content.
167164
165 minLength: 1
166
168167 - `type: "text"`
169168
170 - `"text"`
169 - `BetaManagedAgentsImageBlock object`
171170
172 - `BetaManagedAgentsImageBlock object { source, type }`
173
174171 Image content specified directly as base64 data or as a reference via a URL.
175172
176173 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
from line 174
177174
178175 Union type for image source variants.
179176
180 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
177 - `BetaManagedAgentsBase64ImageSource object`
181178
182179 Base64-encoded image data.
183180
from line 182
185182
186183 Base64-encoded image data.
187184
185 minLength: 1
186
188187 - `media_type: string`
189188
190189 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
191190
191 minLength: 1
192
192193 - `type: "base64"`
193194
194 - `"base64"`
195 - `BetaManagedAgentsURLImageSource object`
195196
196 - `BetaManagedAgentsURLImageSource object { type, url }`
197
198197 Image referenced by URL.
199198
200199 - `type: "url"`
201200
202 - `"url"`
203
204201 - `url: string`
205202
206203 URL of the image to fetch.
207204
208 - `BetaManagedAgentsFileImageSource object { file_id, type }`
205 minLength: 1
209206
207 - `BetaManagedAgentsFileImageSource object`
208
210209 Image referenced by file ID.
211210
212211 - `file_id: string`
from line 212
213212
214213 ID of a previously uploaded file.
215214
215 minLength: 1
216
216217 - `type: "file"`
217218
218 - `"file"`
219
220219 - `type: "image"`
221220
222 - `"image"`
221 - `BetaManagedAgentsDocumentBlock object`
223222
224 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
225
226223 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
227224
228225 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
from line 226
229226
230227 Union type for document source variants.
231228
232 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
229 - `BetaManagedAgentsBase64DocumentSource object`
233230
234231 Base64-encoded document data.
235232
from line 234
237234
238235 Base64-encoded document data.
239236
237 minLength: 1
238
240239 - `media_type: string`
241240
242241 MIME type of the document (e.g., "application/pdf").
243242
243 minLength: 1
244
244245 - `type: "base64"`
245246
246 - `"base64"`
247 - `BetaManagedAgentsPlainTextDocumentSource object`
247248
248 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
249
250249 Plain text document content.
251250
252251 - `data: string`
from line 252
253252
254253 The plain text content.
255254
255 minLength: 1
256
256257 - `media_type: "text/plain"`
257258
258259 MIME type of the text content. Must be "text/plain".
259260
260 - `"text/plain"`
261
262261 - `type: "text"`
263262
264 - `"text"`
263 - `BetaManagedAgentsURLDocumentSource object`
265264
266 - `BetaManagedAgentsURLDocumentSource object { type, url }`
267
268265 Document referenced by URL.
269266
270267 - `type: "url"`
271268
272 - `"url"`
273
274269 - `url: string`
275270
276271 URL of the document to fetch.
277272
278 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`
273 minLength: 1
279274
275 - `BetaManagedAgentsFileDocumentSource object`
276
280277 Document referenced by file ID.
281278
282279 - `file_id: string`
from line 280
283280
284281 ID of a previously uploaded file.
285282
283 minLength: 1
284
286285 - `type: "file"`
287286
288 - `"file"`
289
290287 - `type: "document"`
291288
292 - `"document"`
293
294289 - `context: optional string or null`
295290
296291 Additional context about the document for the model.
from line 294
299294
300295 The title of the document.
301296
302 - `BetaManagedAgentsRedactedBlock object { type }`
297 - `BetaManagedAgentsRedactedBlock object`
303298
304299 Placeholder for content withheld by Anthropic model policy.
305300
306301 - `type: "redacted"`
307302
308 - `"redacted"`
309
310303 - `type: "user.message"`
311304
312 - `"user.message"`
305 - `BetaManagedAgentsUserDefineOutcomeEventParams object`
313306
314 - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`
315
316307 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
317308
318309 - `description: string`
from line 314
323314
324315 Rubric for grading the quality of an outcome.
325316
326 - `BetaManagedAgentsFileRubricParams object { file_id, type }`
317 - `BetaManagedAgentsFileRubricParams object`
327318
328319 Rubric referenced by a file uploaded via the Files API.
329320
from line 324
333324
334325 - `type: "file"`
335326
336 - `"file"`
327 - `BetaManagedAgentsTextRubricParams object`
337328
338 - `BetaManagedAgentsTextRubricParams object { content, type }`
339
340329 Rubric content provided inline as text.
341330
342331 - `content: string`
from line 332
343332
344333 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.
345334
335 maxLength: 262144
336
346337 - `type: "text"`
347338
348 - `"text"`
349
350339 - `type: "user.define_outcome"`
351340
352 - `"user.define_outcome"`
353
354341 - `max_iterations: optional number or null`
355342
356343 Eval→revision cycles before giving up. Default 3, max 20.
357344
358 - `BetaManagedAgentsSystemMessageEventParams object { content, type }`
345 format: int32
359346
347 - `BetaManagedAgentsSystemMessageEventParams object`
348
360349 Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages.
361350
362351 - `content: array of BetaManagedAgentsSystemContentBlock`
from line 356
367356
368357 The text content.
369358
359 minLength: 1
360
370361 - `type: "text"`
371362
372 - `"text"`
373
374363 - `type: "system.message"`
375364
376 - `"system.message"`
377
378365- `metadata: optional map[string] or null`
379366
380367 Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.
from line 370
383370
384371 Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.
385372
373 maxLength: 256
374
386375- `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null`
387376
388377 Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.
389378
390 - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }`
379 - `BetaManagedAgentsGitHubRepositoryResourceParams object`
391380
392381 Mount a GitHub repository into the session's container.
393382
from line 384
395384
396385 GitHub authorization token used to clone the repository.
397386
387 minLength: 1, maxLength: 4096
388
398389 - `type: "github_repository"`
399390
400 - `"github_repository"`
401
402391 - `url: string`
403392
404393 Github URL of the repository
405394
395 minLength: 1, maxLength: 2048
396
406397 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`
407398
408399 Branch or commit to check out. Defaults to the repository's default branch.
409400
410 - `BetaManagedAgentsBranchCheckout object { name, type }`
401 - `BetaManagedAgentsBranchCheckout object`
411402
412403 - `name: string`
413404
414405 Branch name to check out.
415406
407 minLength: 1, maxLength: 255
408
416409 - `type: "branch"`
417410
418 - `"branch"`
411 - `BetaManagedAgentsCommitCheckout object`
419412
420 - `BetaManagedAgentsCommitCheckout object { sha, type }`
421
422413 - `sha: string`
423414
424415 Full commit SHA to check out.
425416
417 minLength: 7, maxLength: 64
418
426419 - `type: "commit"`
427420
428 - `"commit"`
429
430421 - `mount_path: optional string or null`
431422
432423 Mount path in the container. Defaults to `/workspace/<repo-name>`.
433424
434 - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }`
425 minLength: 1, maxLength: 4096
435426
427 - `BetaManagedAgentsFileResourceParams object`
428
436429 Mount a file uploaded via the Files API into the session.
437430
438431 - `file_id: string`
from line 432
439432
440433 ID of a previously uploaded file.
441434
435 minLength: 1, maxLength: 128
436
442437 - `type: "file"`
443438
444 - `"file"`
445
446439 - `mount_path: optional string or null`
447440
448441 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
449442
450 - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }`
443 minLength: 1, maxLength: 4096
451444
445 - `BetaManagedAgentsMemoryStoreResourceParam object`
446
452447 Parameters for attaching a memory store to an agent session.
453448
454449 - `memory_store_id: string`
from line 452
457452
458453 - `type: "memory_store"`
459454
460 - `"memory_store"`
461
462455 - `access: optional "read_write" or "read_only" or null`
463456
464457 Access mode for an attached memory store.
from line 464
471464
472465 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
473466
467 maxLength: 4096
468
474469- `schedule: optional BetaManagedAgentsScheduleParams or null`
475470
476471 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
from line 474
479474
480475 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).
481476
477 minLength: 1, maxLength: 256
478
482479 - `timezone: string`
483480
484481 Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
485482
483 minLength: 1
484
486485 - `type: "cron"`
487486
488 - `"cron"`
489
490487- `vault_ids: optional array of string or null`
491488
492489 Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.
493490
494### Returns
491## Returns
495492
496- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
493- `BetaManagedAgentsDeployment object`
497494
498495 A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
499496
from line 506
509506
510507 - `type: "agent"`
511508
512 - `"agent"`
513
514509 - `version: number`
515510
511 format: int32
512
516513 - `archived_at: string or null`
517514
518515 A timestamp in RFC 3339 format
519516
517 format: date-time
518
520519 - `created_at: string`
521520
522521 A timestamp in RFC 3339 format
523522
523 format: date-time
524
524525 - `description: string or null`
525526
526527 Description of what the deployment does.
from line 534
533534
534535 Events sent to each session immediately after creation.
535536
536 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
537 - `BetaManagedAgentsDeploymentUserMessageEvent object`
537538
538539 A user message sent to the session.
539540
from line 542
541542
542543 Array of content blocks for the user message.
543544
544 - `BetaManagedAgentsTextBlock object { text, type }`
545 - `BetaManagedAgentsTextBlock object`
545546
546547 Regular text content.
547548
from line 550
549550
550551 The text content.
551552
553 minLength: 1
554
552555 - `type: "text"`
553556
554 - `"text"`
557 - `BetaManagedAgentsImageBlock object`
555558
556 - `BetaManagedAgentsImageBlock object { source, type }`
557
558559 Image content specified directly as base64 data or as a reference via a URL.
559560
560561 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
from line 562
561562
562563 Union type for image source variants.
563564
564 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
565 - `BetaManagedAgentsBase64ImageSource object`
565566
566567 Base64-encoded image data.
567568
from line 570
569570
570571 Base64-encoded image data.
571572
573 minLength: 1
574
572575 - `media_type: string`
573576
574577 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
575578
579 minLength: 1
580
576581 - `type: "base64"`
577582
578 - `"base64"`
583 - `BetaManagedAgentsURLImageSource object`
579584
580 - `BetaManagedAgentsURLImageSource object { type, url }`
581
582585 Image referenced by URL.
583586
584587 - `type: "url"`
585588
586 - `"url"`
587
588589 - `url: string`
589590
590591 URL of the image to fetch.
591592
592 - `BetaManagedAgentsFileImageSource object { file_id, type }`
593 minLength: 1
593594
595 - `BetaManagedAgentsFileImageSource object`
596
594597 Image referenced by file ID.
595598
596599 - `file_id: string`
from line 600
597600
598601 ID of a previously uploaded file.
599602
603 minLength: 1
604
600605 - `type: "file"`
601606
602 - `"file"`
603
604607 - `type: "image"`
605608
606 - `"image"`
609 - `BetaManagedAgentsDocumentBlock object`
607610
608 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
609
610611 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
611612
612613 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
from line 614
613614
614615 Union type for document source variants.
615616
616 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
617 - `BetaManagedAgentsBase64DocumentSource object`
617618
618619 Base64-encoded document data.
619620
from line 622
621622
622623 Base64-encoded document data.
623624
625 minLength: 1
626
624627 - `media_type: string`
625628
626629 MIME type of the document (e.g., "application/pdf").
627630
631 minLength: 1
632
628633 - `type: "base64"`
629634
630 - `"base64"`
635 - `BetaManagedAgentsPlainTextDocumentSource object`
631636
632 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
633
634637 Plain text document content.
635638
636639 - `data: string`
from line 640
637640
638641 The plain text content.
639642
643 minLength: 1
644
640645 - `media_type: "text/plain"`
641646
642647 MIME type of the text content. Must be "text/plain".
643648
644 - `"text/plain"`
645
646649 - `type: "text"`
647650
648 - `"text"`
651 - `BetaManagedAgentsURLDocumentSource object`
649652
650 - `BetaManagedAgentsURLDocumentSource object { type, url }`
651
652653 Document referenced by URL.
653654
654655 - `type: "url"`
655656
656 - `"url"`
657
658657 - `url: string`
659658
660659 URL of the document to fetch.
661660
662 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`
661 minLength: 1
663662
663 - `BetaManagedAgentsFileDocumentSource object`
664
664665 Document referenced by file ID.
665666
666667 - `file_id: string`
from line 668
667668
668669 ID of a previously uploaded file.
669670
671 minLength: 1
672
670673 - `type: "file"`
671674
672 - `"file"`
673
674675 - `type: "document"`
675676
676 - `"document"`
677
678677 - `context: optional string or null`
679678
680679 Additional context about the document for the model.
from line 682
683682
684683 The title of the document.
685684
686 - `BetaManagedAgentsRedactedBlock object { type }`
685 - `BetaManagedAgentsRedactedBlock object`
687686
688687 Placeholder for content withheld by Anthropic model policy.
689688
690689 - `type: "redacted"`
691690
692 - `"redacted"`
693
694691 - `type: "user.message"`
695692
696 - `"user.message"`
693 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`
697694
698 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
699
700695 An outcome the agent should work toward. The agent begins work on receipt.
701696
702697 - `description: string`
from line 702
707702
708703 Rubric for grading the quality of an outcome.
709704
710 - `BetaManagedAgentsFileRubric object { file_id, type }`
705 - `BetaManagedAgentsFileRubric object`
711706
712707 Rubric referenced by a file uploaded via the Files API.
713708
from line 712
717712
718713 - `type: "file"`
719714
720 - `"file"`
715 - `BetaManagedAgentsTextRubric object`
721716
722 - `BetaManagedAgentsTextRubric object { content, type }`
723
724717 Rubric content provided inline as text.
725718
726719 - `content: string`
from line 722
729722
730723 - `type: "text"`
731724
732 - `"text"`
733
734725 - `type: "user.define_outcome"`
735726
736 - `"user.define_outcome"`
737
738727 - `max_iterations: optional number or null`
739728
740729 Eval→revision cycles before giving up. Default 3, max 20.
741730
742 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`
731 format: int32
743732
733 - `BetaManagedAgentsDeploymentSystemMessageEvent object`
734
744735 Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt.
745736
746737 - `content: array of BetaManagedAgentsSystemContentBlock`
from line 742
751742
752743 The text content.
753744
745 minLength: 1
746
754747 - `type: "text"`
755748
756 - `"text"`
757
758749 - `type: "system.message"`
759750
760 - `"system.message"`
761
762751 - `metadata: map[string]`
763752
764753 Arbitrary key-value metadata. Maximum 16 pairs.
from line 760
771760
772761 Why a deployment is paused. Non-null exactly when `status` is `paused`.
773762
774 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`
763 - `BetaManagedAgentsManualDeploymentPausedReason object`
775764
776765 The caller invoked the pause endpoint on the deployment.
777766
778767 - `type: "manual"`
779768
780 - `"manual"`
769 - `BetaManagedAgentsErrorDeploymentPausedReason object`
781770
782 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`
783
784771 A scheduled fire recorded a failed run whose error auto-pauses the deployment.
785772
786773 - `error: BetaManagedAgentsDeploymentPausedReasonError`
from line 774
787774
788775 The error that triggered an auto-pause. Matches the failed run's `error.type`.
789776
790 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`
777 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`
791778
792779 The deployment's environment was archived.
793780
794781 - `type: "environment_archived_error"`
795782
796 - `"environment_archived_error"`
783 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`
797784
798 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`
799
800785 The deployment's agent was archived.
801786
802787 - `type: "agent_archived_error"`
803788
804 - `"agent_archived_error"`
789 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`
805790
806 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`
807
808791 The deployment's environment no longer exists.
809792
810793 - `type: "environment_not_found_error"`
811794
812 - `"environment_not_found_error"`
795 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`
813796
814 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`
815
816797 A vault referenced by the deployment no longer exists.
817798
818799 - `type: "vault_not_found_error"`
819800
820 - `"vault_not_found_error"`
801 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`
821802
822 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`
823
824803 A file resource referenced by the deployment no longer exists.
825804
826805 - `type: "file_not_found_error"`
827806
828 - `"file_not_found_error"`
807 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`
829808
830 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`
831
832809 A referenced resource no longer exists and its kind was not reported.
833810
834811 - `type: "session_resource_not_found_error"`
835812
836 - `"session_resource_not_found_error"`
813 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`
837814
838 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`
839
840815 The deployment's workspace was archived.
841816
842817 - `type: "workspace_archived_error"`
843818
844 - `"workspace_archived_error"`
819 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`
845820
846 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`
847
848821 The deployment's organization is disabled.
849822
850823 - `type: "organization_disabled_error"`
851824
852 - `"organization_disabled_error"`
825 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`
853826
854 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`
855
856827 A memory store referenced by the deployment is archived.
857828
858829 - `type: "memory_store_archived_error"`
859830
860 - `"memory_store_archived_error"`
831 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`
861832
862 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`
863
864833 A skill referenced by the deployment's agent no longer exists.
865834
866835 - `type: "skill_not_found_error"`
867836
868 - `"skill_not_found_error"`
837 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`
869838
870 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`
871
872839 A vault referenced by the deployment is archived.
873840
874841 - `type: "vault_archived_error"`
875842
876 - `"vault_archived_error"`
843 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`
877844
878 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`
879
880845 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.
881846
882847 - `type: "unknown_error"`
883848
884 - `"unknown_error"`
849 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`
885850
886 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`
887
888851 The deployment configures resources, but its environment is self-hosted and cannot mount them.
889852
890853 - `type: "self_hosted_resources_unsupported_error"`
891854
892 - `"self_hosted_resources_unsupported_error"`
855 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`
893856
894 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`
895
896857 An MCP server host used by the deployment's agent is blocked by the environment's network policy.
897858
898859 - `type: "mcp_egress_blocked_error"`
899860
900 - `"mcp_egress_blocked_error"`
901
902861 - `type: "error"`
903862
904 - `"error"`
905
906863 - `resources: array of BetaManagedAgentsSessionResourceConfig`
907864
908865 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
909866
910 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`
867 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`
911868
912869 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
913870
914871 - `type: "github_repository"`
915872
916 - `"github_repository"`
917
918873 - `url: string`
919874
920875 Github URL of the repository
from line 878
923878
924879 Branch or commit to check out. Defaults to the repository's default branch.
925880
926 - `BetaManagedAgentsBranchCheckout object { name, type }`
881 - `BetaManagedAgentsBranchCheckout object`
927882
928883 - `name: string`
929884
930885 Branch name to check out.
931886
887 minLength: 1, maxLength: 255
888
932889 - `type: "branch"`
933890
934 - `"branch"`
891 - `BetaManagedAgentsCommitCheckout object`
935892
936 - `BetaManagedAgentsCommitCheckout object { sha, type }`
937
938893 - `sha: string`
939894
940895 Full commit SHA to check out.
941896
897 minLength: 7, maxLength: 64
898
942899 - `type: "commit"`
943900
944 - `"commit"`
945
946901 - `mount_path: optional string or null`
947902
948903 Mount path in the container. Defaults to `/workspace/<repo-name>`.
949904
950 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`
905 - `BetaManagedAgentsFileResourceConfig object`
951906
952907 A file mounted into each session's container.
953908
from line 912
957912
958913 - `type: "file"`
959914
960 - `"file"`
961
962915 - `mount_path: optional string or null`
963916
964917 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
965918
966 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`
919 - `BetaManagedAgentsMemoryStoreResourceConfig object`
967920
968921 A memory store attached to each session created from this deployment.
969922
from line 926
973926
974927 - `type: "memory_store"`
975928
976 - `"memory_store"`
977
978929 - `access: optional "read_write" or "read_only" or null`
979930
980931 Access mode for an attached memory store.
from line 946
995946
996947 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).
997948
949 minLength: 1, maxLength: 256
950
998951 - `timezone: string`
999952
1000953 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
1001954
955 minLength: 1
956
1002957 - `type: "cron"`
1003958
1004 - `"cron"`
1005
1006959 - `last_run_at: optional string or null`
1007960
1008961 A timestamp in RFC 3339 format
1009962
963 format: date-time
964
1010965 - `upcoming_runs_at: optional array of string`
1011966
1012967 Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time.
from line 976
1021976
1022977 - `type: "deployment"`
1023978
1024 - `"deployment"`
1025
1026979 - `updated_at: string`
1027980
1028981 A timestamp in RFC 3339 format
1029982
983 format: date-time
984
1030985 - `vault_ids: array of string`
1031986
1032987 Vault IDs supplying stored credentials for sessions created from this deployment.
from line 1002
10471002
10481003 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.
10491004
1050 - `"USD"`
1051
10521005 - `type: "limit"`
10531006
1054 - `"limit"`
1007## Example
10551008
1056### Example
1057
1058```http
1009```bash
10591010curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \
10601011 -H 'Content-Type: application/json' \
10611012 -H 'anthropic-version: 2023-06-01' \
from line 1015
10641015 -d '{}'
10651016```
10661017
1067#### Response
1018### Response (200)
10681019
10691020```json
10701021{
No line in this hunk matches that.