The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Update Deployment
3url: https://platform.claude.com/docs/en/api/beta/deployments/update
4---
5
16# Update Deployment
27
38**POST** `/v1/deployments/{deployment_id}`
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 113
106113
107114 - `"mid-conversation-system-clear-at-2026-08-21"`
108115
116- `"anthropic-workspace-id": optional string`
117
109118## Body parameters
110119
111120- `agent: optional string or BetaManagedAgentsAgentParams`
from line 127
118127
119128 Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
120129
130 - `type: "agent"`
131
121132 - `id: string`
122133
123134 The `agent` ID.
from line 135
124135
125136 minLength: 1, maxLength: 128
126137
127 - `type: "agent"`
128
129138 - `version: optional number`
130139
131140 The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.
from line 145
136145
137146 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
138147
148 - `type: "limit"`
149
139150 - `max_list_cost: BetaMonetaryAmount`
140151
141152 A monetary amount in a specific currency.
from line 159
148159
149160 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.
150161
151 - `type: "limit"`
152
153162- `description: optional string or null`
154163
155164 Description. Omit to preserve; send empty string or null to clear.
from line 179
170179
171180 Parameters for sending a user message to the session.
172181
182 - `type: "user.message"`
183
173184 - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
174185
175186 Array of content blocks for the user message.
from line 189
178189
179190 Regular text content.
180191
192 - `type: "text"`
193
181194 - `text: string`
182195
183196 The text content.
from line 197
184197
185198 minLength: 1
186199
187 - `type: "text"`
188
189200 - `BetaManagedAgentsImageBlock object`
190201
191202 Image content specified directly as base64 data or as a reference via a URL.
192203
204 - `type: "image"`
205
193206 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
194207
195208 Union type for image source variants.
from line 211
198211
199212 Base64-encoded image data.
200213
214 - `type: "base64"`
215
201216 - `data: string`
202217
203218 Base64-encoded image data.
from line 225
210225
211226 minLength: 1
212227
213 - `type: "base64"`
214
215228 - `BetaManagedAgentsURLImageSource object`
216229
217230 Image referenced by URL.
from line 241
228241
229242 Image referenced by file ID.
230243
244 - `type: "file"`
245
231246 - `file_id: string`
232247
233248 ID of a previously uploaded file.
from line 249
234249
235250 minLength: 1
236251
237 - `type: "file"`
238
239 - `type: "image"`
240
241252 - `BetaManagedAgentsDocumentBlock object`
242253
243254 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
244255
256 - `type: "document"`
257
245258 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
246259
247260 Union type for document source variants.
from line 263
250263
251264 Base64-encoded document data.
252265
266 - `type: "base64"`
267
253268 - `data: string`
254269
255270 Base64-encoded document data.
from line 277
262277
263278 minLength: 1
264279
265 - `type: "base64"`
266
267280 - `BetaManagedAgentsPlainTextDocumentSource object`
268281
269282 Plain text document content.
270283
284 - `type: "text"`
285
271286 - `data: string`
272287
273288 The plain text content.
from line 293
278293
279294 MIME type of the text content. Must be "text/plain".
280295
281 - `type: "text"`
282
283296 - `BetaManagedAgentsURLDocumentSource object`
284297
285298 Document referenced by URL.
from line 309
296309
297310 Document referenced by file ID.
298311
312 - `type: "file"`
313
299314 - `file_id: string`
300315
301316 ID of a previously uploaded file.
from line 317
302317
303318 minLength: 1
304319
305 - `type: "file"`
306
307 - `type: "document"`
308
309320 - `context: optional string or null`
310321
311322 Additional context about the document for the model.
from line 331
320331
321332 - `type: "redacted"`
322333
323 - `type: "user.message"`
324
325334 - `BetaManagedAgentsUserDefineOutcomeEventParams object`
326335
327336 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
328337
338 - `type: "user.define_outcome"`
339
329340 - `description: string`
330341
331342 What the agent should produce. This is the task specification.
from line 349
338349
339350 Rubric referenced by a file uploaded via the Files API.
340351
352 - `type: "file"`
353
341354 - `file_id: string`
342355
343356 ID of the rubric file.
344357
345 - `type: "file"`
346
347358 - `BetaManagedAgentsTextRubricParams object`
348359
349360 Rubric content provided inline as text.
350361
362 - `type: "text"`
363
351364 - `content: string`
352365
353366 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.
from line 367
354367
355368 maxLength: 262144
356369
357 - `type: "text"`
358
359 - `type: "user.define_outcome"`
360
361370 - `max_iterations: optional number or null`
362371
363372 Eval→revision cycles before giving up. Default 3, max 20.
from line 377
368377
369378 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.
370379
380 - `type: "system.message"`
381
371382 - `content: array of BetaManagedAgentsSystemContentBlock`
372383
373384 System content blocks to append. Text-only.
374385
386 - `type: "text"`
387
375388 - `text: string`
376389
377390 The text content.
from line 391
378391
379392 minLength: 1
380393
381 - `type: "text"`
382
383 - `type: "system.message"`
384
385394- `metadata: optional map[string] or null`
386395
387396 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 409
400409
401410 Mount a GitHub repository into the session's container.
402411
403 - `authorization_token: string`
404
405 GitHub authorization token used to clone the repository.
406
407 minLength: 1, maxLength: 4096
408
409412 - `type: "github_repository"`
410413
411414 - `url: string`
from line 417
414417
415418 minLength: 1, maxLength: 2048
416419
420 - `authorization_token: optional string`
421
422 GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.
423
424 minLength: 1, maxLength: 4096
425
417426 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`
418427
419428 Branch or commit to check out. Defaults to the repository's default branch.
from line 429
420429
421430 - `BetaManagedAgentsBranchCheckout object`
422431
432 - `type: "branch"`
433
423434 - `name: string`
424435
425436 Branch name to check out.
from line 437
426437
427438 minLength: 1, maxLength: 255
428439
429 - `type: "branch"`
430
431440 - `BetaManagedAgentsCommitCheckout object`
432441
442 - `type: "commit"`
443
433444 - `sha: string`
434445
435446 Full commit SHA to check out.
from line 447
436447
437448 minLength: 7, maxLength: 64
438449
439 - `type: "commit"`
440
441450 - `mount_path: optional string or null`
442451
443452 Mount path in the container. Defaults to `/workspace/<repo-name>`.
from line 457
448457
449458 Mount a file uploaded via the Files API into the session.
450459
460 - `type: "file"`
461
451462 - `file_id: string`
452463
453464 ID of a previously uploaded file.
from line 465
454465
455466 minLength: 1, maxLength: 128
456467
457 - `type: "file"`
458
459468 - `mount_path: optional string or null`
460469
461470 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
from line 475
466475
467476 Parameters for attaching a memory store to an agent session.
468477
478 - `type: "memory_store"`
479
469480 - `memory_store_id: string`
470481
471482 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
472483
473 - `type: "memory_store"`
474
475484 - `access: optional "read_write" or "read_only" or null`
476485
477486 Access mode for an attached memory store.
from line 499
490499
491500 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
492501
502 - `type: "cron"`
503
493504 - `expression: string`
494505
495506 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).
from line 513
502513
503514 minLength: 1
504515
505 - `type: "cron"`
506
507516- `vault_ids: optional array of string or null`
508517
509518 Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.
from line 523
514523
515524 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.
516525
526 - `type: "deployment"`
527
517528 - `id: string`
518529
519530 Unique identifier for this deployment.
from line 533
522533
523534 A resolved agent reference with a concrete version.
524535
525 - `id: string`
526
527536 - `type: "agent"`
528537
538 - `id: string`
539
529540 - `version: number`
530541
531542 format: int32
from line 569
558569
559570 A user message sent to the session.
560571
572 - `type: "user.message"`
573
561574 - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
562575
563576 Array of content blocks for the user message.
from line 579
566579
567580 Regular text content.
568581
582 - `type: "text"`
583
569584 - `text: string`
570585
571586 The text content.
from line 587
572587
573588 minLength: 1
574589
575 - `type: "text"`
576
577590 - `BetaManagedAgentsImageBlock object`
578591
579592 Image content specified directly as base64 data or as a reference via a URL.
580593
594 - `type: "image"`
595
581596 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
582597
583598 Union type for image source variants.
from line 601
586601
587602 Base64-encoded image data.
588603
604 - `type: "base64"`
605
589606 - `data: string`
590607
591608 Base64-encoded image data.
from line 615
598615
599616 minLength: 1
600617
601 - `type: "base64"`
602
603618 - `BetaManagedAgentsURLImageSource object`
604619
605620 Image referenced by URL.
from line 631
616631
617632 Image referenced by file ID.
618633
634 - `type: "file"`
635
619636 - `file_id: string`
620637
621638 ID of a previously uploaded file.
from line 639
622639
623640 minLength: 1
624641
625 - `type: "file"`
626
627 - `type: "image"`
628
629642 - `BetaManagedAgentsDocumentBlock object`
630643
631644 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
632645
646 - `type: "document"`
647
633648 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
634649
635650 Union type for document source variants.
from line 653
638653
639654 Base64-encoded document data.
640655
656 - `type: "base64"`
657
641658 - `data: string`
642659
643660 Base64-encoded document data.
from line 667
650667
651668 minLength: 1
652669
653 - `type: "base64"`
654
655670 - `BetaManagedAgentsPlainTextDocumentSource object`
656671
657672 Plain text document content.
658673
674 - `type: "text"`
675
659676 - `data: string`
660677
661678 The plain text content.
from line 683
666683
667684 MIME type of the text content. Must be "text/plain".
668685
669 - `type: "text"`
670
671686 - `BetaManagedAgentsURLDocumentSource object`
672687
673688 Document referenced by URL.
from line 699
684699
685700 Document referenced by file ID.
686701
702 - `type: "file"`
703
687704 - `file_id: string`
688705
689706 ID of a previously uploaded file.
from line 707
690707
691708 minLength: 1
692709
693 - `type: "file"`
694
695 - `type: "document"`
696
697710 - `context: optional string or null`
698711
699712 Additional context about the document for the model.
from line 721
708721
709722 - `type: "redacted"`
710723
711 - `type: "user.message"`
712
713724 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`
714725
715726 An outcome the agent should work toward. The agent begins work on receipt.
716727
728 - `type: "user.define_outcome"`
729
717730 - `description: string`
718731
719732 What the agent should produce. This is the task specification.
from line 739
726739
727740 Rubric referenced by a file uploaded via the Files API.
728741
742 - `type: "file"`
743
729744 - `file_id: string`
730745
731746 ID of the rubric file.
732747
733 - `type: "file"`
734
735748 - `BetaManagedAgentsTextRubric object`
736749
737750 Rubric content provided inline as text.
738751
752 - `type: "text"`
753
739754 - `content: string`
740755
741756 Rubric content. Plain text or markdown — the grader treats it as freeform text.
742757
743 - `type: "text"`
744
745 - `type: "user.define_outcome"`
746
747758 - `max_iterations: optional number or null`
748759
749760 Eval→revision cycles before giving up. Default 3, max 20.
from line 765
754765
755766 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.
756767
768 - `type: "system.message"`
769
757770 - `content: array of BetaManagedAgentsSystemContentBlock`
758771
759772 System content blocks to append. Text-only.
760773
774 - `type: "text"`
775
761776 - `text: string`
762777
763778 The text content.
from line 779
764779
765780 minLength: 1
766781
767 - `type: "text"`
768
769 - `type: "system.message"`
770
771782 - `metadata: map[string]`
772783
773784 Arbitrary key-value metadata. Maximum 16 pairs.
from line 801
790801
791802 A scheduled fire recorded a failed run whose error auto-pauses the deployment.
792803
804 - `type: "error"`
805
793806 - `error: BetaManagedAgentsDeploymentPausedReasonError`
794807
795808 The error that triggered an auto-pause. Matches the failed run's `error.type`.
from line 891
878891
879892 - `type: "mcp_egress_blocked_error"`
880893
881 - `type: "error"`
882
883894 - `resources: array of BetaManagedAgentsSessionResourceConfig`
884895
885896 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
from line 911
900911
901912 - `BetaManagedAgentsBranchCheckout object`
902913
914 - `type: "branch"`
915
903916 - `name: string`
904917
905918 Branch name to check out.
from line 919
906919
907920 minLength: 1, maxLength: 255
908921
909 - `type: "branch"`
910
911922 - `BetaManagedAgentsCommitCheckout object`
912923
924 - `type: "commit"`
925
913926 - `sha: string`
914927
915928 Full commit SHA to check out.
from line 929
916929
917930 minLength: 7, maxLength: 64
918931
919 - `type: "commit"`
920
921932 - `mount_path: optional string or null`
922933
923934 Mount path in the container. Defaults to `/workspace/<repo-name>`.
from line 937
926937
927938 A file mounted into each session's container.
928939
940 - `type: "file"`
941
929942 - `file_id: string`
930943
931944 ID of a previously uploaded file.
932945
933 - `type: "file"`
934
935946 - `mount_path: optional string or null`
936947
937948 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
from line 951
940951
941952 A memory store attached to each session created from this deployment.
942953
954 - `type: "memory_store"`
955
943956 - `memory_store_id: string`
944957
945958 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
946959
947 - `type: "memory_store"`
948
949960 - `access: optional "read_write" or "read_only" or null`
950961
951962 Access mode for an attached memory store.
from line 973
962973
963974 5-field POSIX cron schedule with computed runtime timestamps.
964975
976 - `type: "cron"`
977
965978 - `expression: string`
966979
967980 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).
from line 987
974987
975988 minLength: 1
976989
977 - `type: "cron"`
978
979990 - `last_run_at: optional string or null`
980991
981992 A timestamp in RFC 3339 format
from line 1005
9941005
9951006 - `"paused"`
9961007
997 - `type: "deployment"`
998
9991008 - `updated_at: string`
10001009
10011010 A timestamp in RFC 3339 format
from line 1019
10101019
10111020 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
10121021
1022 - `type: "limit"`
1023
10131024 - `max_list_cost: BetaMonetaryAmount`
10141025
10151026 A monetary amount in a specific currency.
from line 1032
10211032 - `currency: BetaCurrency`
10221033
10231034 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.
1024
1025 - `type: "limit"`
10261035
10271036## Example
10281037