The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: Get Deployment
3url: https://platform.claude.com/docs/en/api/beta/deployments/retrieve
4---
5
16# Get Deployment
27
38**GET** `/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## Returns
110119
111120- `BetaManagedAgentsDeployment object`
from line 121
112121
113122 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.
114123
124 - `type: "deployment"`
125
115126 - `id: string`
116127
117128 Unique identifier for this deployment.
from line 131
120131
121132 A resolved agent reference with a concrete version.
122133
123 - `id: string`
124
125134 - `type: "agent"`
126135
136 - `id: string`
137
127138 - `version: number`
128139
129140 format: int32
from line 167
156167
157168 A user message sent to the session.
158169
170 - `type: "user.message"`
171
159172 - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
160173
161174 Array of content blocks for the user message.
from line 177
164177
165178 Regular text content.
166179
180 - `type: "text"`
181
167182 - `text: string`
168183
169184 The text content.
from line 185
170185
171186 minLength: 1
172187
173 - `type: "text"`
174
175188 - `BetaManagedAgentsImageBlock object`
176189
177190 Image content specified directly as base64 data or as a reference via a URL.
178191
192 - `type: "image"`
193
179194 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
180195
181196 Union type for image source variants.
from line 199
184199
185200 Base64-encoded image data.
186201
202 - `type: "base64"`
203
187204 - `data: string`
188205
189206 Base64-encoded image data.
from line 213
196213
197214 minLength: 1
198215
199 - `type: "base64"`
200
201216 - `BetaManagedAgentsURLImageSource object`
202217
203218 Image referenced by URL.
from line 229
214229
215230 Image referenced by file ID.
216231
232 - `type: "file"`
233
217234 - `file_id: string`
218235
219236 ID of a previously uploaded file.
from line 237
220237
221238 minLength: 1
222239
223 - `type: "file"`
224
225 - `type: "image"`
226
227240 - `BetaManagedAgentsDocumentBlock object`
228241
229242 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
230243
244 - `type: "document"`
245
231246 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
232247
233248 Union type for document source variants.
from line 251
236251
237252 Base64-encoded document data.
238253
254 - `type: "base64"`
255
239256 - `data: string`
240257
241258 Base64-encoded document data.
from line 265
248265
249266 minLength: 1
250267
251 - `type: "base64"`
252
253268 - `BetaManagedAgentsPlainTextDocumentSource object`
254269
255270 Plain text document content.
256271
272 - `type: "text"`
273
257274 - `data: string`
258275
259276 The plain text content.
from line 281
264281
265282 MIME type of the text content. Must be "text/plain".
266283
267 - `type: "text"`
268
269284 - `BetaManagedAgentsURLDocumentSource object`
270285
271286 Document referenced by URL.
from line 297
282297
283298 Document referenced by file ID.
284299
300 - `type: "file"`
301
285302 - `file_id: string`
286303
287304 ID of a previously uploaded file.
from line 305
288305
289306 minLength: 1
290307
291 - `type: "file"`
292
293 - `type: "document"`
294
295308 - `context: optional string or null`
296309
297310 Additional context about the document for the model.
from line 319
306319
307320 - `type: "redacted"`
308321
309 - `type: "user.message"`
310
311322 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`
312323
313324 An outcome the agent should work toward. The agent begins work on receipt.
314325
326 - `type: "user.define_outcome"`
327
315328 - `description: string`
316329
317330 What the agent should produce. This is the task specification.
from line 337
324337
325338 Rubric referenced by a file uploaded via the Files API.
326339
340 - `type: "file"`
341
327342 - `file_id: string`
328343
329344 ID of the rubric file.
330345
331 - `type: "file"`
332
333346 - `BetaManagedAgentsTextRubric object`
334347
335348 Rubric content provided inline as text.
336349
350 - `type: "text"`
351
337352 - `content: string`
338353
339354 Rubric content. Plain text or markdown — the grader treats it as freeform text.
340355
341 - `type: "text"`
342
343 - `type: "user.define_outcome"`
344
345356 - `max_iterations: optional number or null`
346357
347358 Eval→revision cycles before giving up. Default 3, max 20.
from line 363
352363
353364 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.
354365
366 - `type: "system.message"`
367
355368 - `content: array of BetaManagedAgentsSystemContentBlock`
356369
357370 System content blocks to append. Text-only.
358371
372 - `type: "text"`
373
359374 - `text: string`
360375
361376 The text content.
from line 377
362377
363378 minLength: 1
364379
365 - `type: "text"`
366
367 - `type: "system.message"`
368
369380 - `metadata: map[string]`
370381
371382 Arbitrary key-value metadata. Maximum 16 pairs.
from line 399
388399
389400 A scheduled fire recorded a failed run whose error auto-pauses the deployment.
390401
402 - `type: "error"`
403
391404 - `error: BetaManagedAgentsDeploymentPausedReasonError`
392405
393406 The error that triggered an auto-pause. Matches the failed run's `error.type`.
from line 489
476489
477490 - `type: "mcp_egress_blocked_error"`
478491
479 - `type: "error"`
480
481492 - `resources: array of BetaManagedAgentsSessionResourceConfig`
482493
483494 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
from line 509
498509
499510 - `BetaManagedAgentsBranchCheckout object`
500511
512 - `type: "branch"`
513
501514 - `name: string`
502515
503516 Branch name to check out.
from line 517
504517
505518 minLength: 1, maxLength: 255
506519
507 - `type: "branch"`
508
509520 - `BetaManagedAgentsCommitCheckout object`
510521
522 - `type: "commit"`
523
511524 - `sha: string`
512525
513526 Full commit SHA to check out.
from line 527
514527
515528 minLength: 7, maxLength: 64
516529
517 - `type: "commit"`
518
519530 - `mount_path: optional string or null`
520531
521532 Mount path in the container. Defaults to `/workspace/<repo-name>`.
from line 535
524535
525536 A file mounted into each session's container.
526537
538 - `type: "file"`
539
527540 - `file_id: string`
528541
529542 ID of a previously uploaded file.
530543
531 - `type: "file"`
532
533544 - `mount_path: optional string or null`
534545
535546 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
from line 549
538549
539550 A memory store attached to each session created from this deployment.
540551
552 - `type: "memory_store"`
553
541554 - `memory_store_id: string`
542555
543556 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
544557
545 - `type: "memory_store"`
546
547558 - `access: optional "read_write" or "read_only" or null`
548559
549560 Access mode for an attached memory store.
from line 571
560571
561572 5-field POSIX cron schedule with computed runtime timestamps.
562573
574 - `type: "cron"`
575
563576 - `expression: string`
564577
565578 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 585
572585
573586 minLength: 1
574587
575 - `type: "cron"`
576
577588 - `last_run_at: optional string or null`
578589
579590 A timestamp in RFC 3339 format
from line 603
592603
593604 - `"paused"`
594605
595 - `type: "deployment"`
596
597606 - `updated_at: string`
598607
599608 A timestamp in RFC 3339 format
from line 617
608617
609618 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
610619
620 - `type: "limit"`
621
611622 - `max_list_cost: BetaMonetaryAmount`
612623
613624 A monetary amount in a specific currency.
from line 630
619630 - `currency: BetaCurrency`
620631
621632 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.
622
623 - `type: "limit"`
624633
625634## Example
626635