The whole hunk
from line 1, old and new numbered
/
lines
from line 1
1---
2title: List Deployments
3url: https://platform.claude.com/docs/en/api/beta/deployments/list
4---
5
16# List Deployments
27
38**GET** `/v1/deployments`
from line 57
5257
5358 - `string`
5459
55 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
60 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
5661
5762 - `"message-batches-2024-09-24"`
5863
from line 105
100105
101106 - `"user-profiles-2026-08-18"`
102107
108 - `"user-profiles-2026-09-04"`
109
103110 - `"advisor-tool-2026-03-01"`
104111
105112 - `"managed-agents-2026-04-01"`
from line 149
142149
143150 - `"mid-conversation-system-clear-at-2026-08-21"`
144151
152- `"anthropic-workspace-id": optional string`
153
145154## Returns
146155
147156- `data: array of BetaManagedAgentsDeployment`
from line 157
148157
149158 List of deployments.
150159
160 - `type: "deployment"`
161
151162 - `id: string`
152163
153164 Unique identifier for this deployment.
from line 167
156167
157168 A resolved agent reference with a concrete version.
158169
159 - `id: string`
160
161170 - `type: "agent"`
162171
172 - `id: string`
173
163174 - `version: number`
164175
165176 format: int32
from line 203
192203
193204 A user message sent to the session.
194205
206 - `type: "user.message"`
207
195208 - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
196209
197210 Array of content blocks for the user message.
from line 213
200213
201214 Regular text content.
202215
216 - `type: "text"`
217
203218 - `text: string`
204219
205220 The text content.
from line 221
206221
207222 minLength: 1
208223
209 - `type: "text"`
210
211224 - `BetaManagedAgentsImageBlock object`
212225
213226 Image content specified directly as base64 data or as a reference via a URL.
214227
228 - `type: "image"`
229
215230 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
216231
217232 Union type for image source variants.
from line 235
220235
221236 Base64-encoded image data.
222237
238 - `type: "base64"`
239
223240 - `data: string`
224241
225242 Base64-encoded image data.
from line 249
232249
233250 minLength: 1
234251
235 - `type: "base64"`
236
237252 - `BetaManagedAgentsURLImageSource object`
238253
239254 Image referenced by URL.
from line 265
250265
251266 Image referenced by file ID.
252267
268 - `type: "file"`
269
253270 - `file_id: string`
254271
255272 ID of a previously uploaded file.
from line 273
256273
257274 minLength: 1
258275
259 - `type: "file"`
260
261 - `type: "image"`
262
263276 - `BetaManagedAgentsDocumentBlock object`
264277
265278 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
266279
280 - `type: "document"`
281
267282 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
268283
269284 Union type for document source variants.
from line 287
272287
273288 Base64-encoded document data.
274289
290 - `type: "base64"`
291
275292 - `data: string`
276293
277294 Base64-encoded document data.
from line 301
284301
285302 minLength: 1
286303
287 - `type: "base64"`
288
289304 - `BetaManagedAgentsPlainTextDocumentSource object`
290305
291306 Plain text document content.
292307
308 - `type: "text"`
309
293310 - `data: string`
294311
295312 The plain text content.
from line 317
300317
301318 MIME type of the text content. Must be "text/plain".
302319
303 - `type: "text"`
304
305320 - `BetaManagedAgentsURLDocumentSource object`
306321
307322 Document referenced by URL.
from line 333
318333
319334 Document referenced by file ID.
320335
336 - `type: "file"`
337
321338 - `file_id: string`
322339
323340 ID of a previously uploaded file.
from line 341
324341
325342 minLength: 1
326343
327 - `type: "file"`
328
329 - `type: "document"`
330
331344 - `context: optional string or null`
332345
333346 Additional context about the document for the model.
from line 355
342355
343356 - `type: "redacted"`
344357
345 - `type: "user.message"`
346
347358 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`
348359
349360 An outcome the agent should work toward. The agent begins work on receipt.
350361
362 - `type: "user.define_outcome"`
363
351364 - `description: string`
352365
353366 What the agent should produce. This is the task specification.
from line 373
360373
361374 Rubric referenced by a file uploaded via the Files API.
362375
376 - `type: "file"`
377
363378 - `file_id: string`
364379
365380 ID of the rubric file.
366381
367 - `type: "file"`
368
369382 - `BetaManagedAgentsTextRubric object`
370383
371384 Rubric content provided inline as text.
372385
386 - `type: "text"`
387
373388 - `content: string`
374389
375390 Rubric content. Plain text or markdown — the grader treats it as freeform text.
376391
377 - `type: "text"`
378
379 - `type: "user.define_outcome"`
380
381392 - `max_iterations: optional number or null`
382393
383394 Eval→revision cycles before giving up. Default 3, max 20.
from line 399
388399
389400 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.
390401
402 - `type: "system.message"`
403
391404 - `content: array of BetaManagedAgentsSystemContentBlock`
392405
393406 System content blocks to append. Text-only.
394407
408 - `type: "text"`
409
395410 - `text: string`
396411
397412 The text content.
from line 413
398413
399414 minLength: 1
400415
401 - `type: "text"`
402
403 - `type: "system.message"`
404
405416 - `metadata: map[string]`
406417
407418 Arbitrary key-value metadata. Maximum 16 pairs.
from line 435
424435
425436 A scheduled fire recorded a failed run whose error auto-pauses the deployment.
426437
438 - `type: "error"`
439
427440 - `error: BetaManagedAgentsDeploymentPausedReasonError`
428441
429442 The error that triggered an auto-pause. Matches the failed run's `error.type`.
from line 525
512525
513526 - `type: "mcp_egress_blocked_error"`
514527
515 - `type: "error"`
516
517528 - `resources: array of BetaManagedAgentsSessionResourceConfig`
518529
519530 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.
from line 545
534545
535546 - `BetaManagedAgentsBranchCheckout object`
536547
548 - `type: "branch"`
549
537550 - `name: string`
538551
539552 Branch name to check out.
from line 553
540553
541554 minLength: 1, maxLength: 255
542555
543 - `type: "branch"`
544
545556 - `BetaManagedAgentsCommitCheckout object`
546557
558 - `type: "commit"`
559
547560 - `sha: string`
548561
549562 Full commit SHA to check out.
from line 563
550563
551564 minLength: 7, maxLength: 64
552565
553 - `type: "commit"`
554
555566 - `mount_path: optional string or null`
556567
557568 Mount path in the container. Defaults to `/workspace/<repo-name>`.
from line 571
560571
561572 A file mounted into each session's container.
562573
574 - `type: "file"`
575
563576 - `file_id: string`
564577
565578 ID of a previously uploaded file.
566579
567 - `type: "file"`
568
569580 - `mount_path: optional string or null`
570581
571582 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.
from line 585
574585
575586 A memory store attached to each session created from this deployment.
576587
588 - `type: "memory_store"`
589
577590 - `memory_store_id: string`
578591
579592 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
580593
581 - `type: "memory_store"`
582
583594 - `access: optional "read_write" or "read_only" or null`
584595
585596 Access mode for an attached memory store.
from line 607
596607
597608 5-field POSIX cron schedule with computed runtime timestamps.
598609
610 - `type: "cron"`
611
599612 - `expression: string`
600613
601614 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 621
608621
609622 minLength: 1
610623
611 - `type: "cron"`
612
613624 - `last_run_at: optional string or null`
614625
615626 A timestamp in RFC 3339 format
from line 639
628639
629640 - `"paused"`
630641
631 - `type: "deployment"`
632
633642 - `updated_at: string`
634643
635644 A timestamp in RFC 3339 format
from line 653
644653
645654 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
646655
656 - `type: "limit"`
657
647658 - `max_list_cost: BetaMonetaryAmount`
648659
649660 A monetary amount in a specific currency.
from line 666
655666 - `currency: BetaCurrency`
656667
657668 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.
658
659 - `type: "limit"`
660669
661670- `next_page: optional string or null`
662671