Home Docs Claude Developer Platform 25 Aug 2026

One change · api

Deployments changedapi/beta/deployments

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 25 Aug 2026 03:37 UTC

Lines+1,092added

Lines−1,643removed

From line 1 where the diff opens

First seen 14 Aug 2026 this site's first read of the page

Recorded edits18to this page, all time

### Headers ### Body parameters #### Response (200) ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Header Parameters ### Body Parameters #### Response ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types

The whole hunk

from line 1, old and new numbered

lines

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: Deployments

3url: https://platform.claude.com/docs/en/api/beta/deployments

4---

61# Deployments

83## Create Deployment

10**post** `/v1/deployments`

5**POST** `/v1/deployments`

116

127Create Deployment

138

14### Header Parameters

9### Headers

1510

1611- `"anthropic-beta": optional array of AnthropicBeta`

1712

from line 84

8984

9085 - `"mid-conversation-tool-changes-2026-07-01"`

9186

92### Body Parameters

87### Body parameters

9388

9489- `agent: string or BetaManagedAgentsAgentParams`

9590

from line 92

9792

9893 - `string`

9994

100 - `BetaManagedAgentsAgentParams object { id, type, version }`

95 - `BetaManagedAgentsAgentParams object`

10196

10297 Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version

10398

from line 100

105100

106101 The `agent` ID.

107102

103 minLength: 1, maxLength: 128

104

108105 - `type: "agent"`

109106

110 - `"agent"`

111

112107 - `version: optional number`

113108

114109 The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.

115110

111 format: int32

112

116113- `environment_id: string`

117114

118115 ID of the `environment` defining the container configuration for sessions created from this deployment.

119116

117 minLength: 1, maxLength: 128

118

120119- `initial_events: array of BetaManagedAgentsDeploymentInitialEventParams`

121120

122121 Events to send to each session immediately after creation. At least 1, maximum 50.

123122

124 - `BetaManagedAgentsUserMessageEventParams object { content, type }`

123 - `BetaManagedAgentsUserMessageEventParams object`

125124

126125 Parameters for sending a user message to the session.

127126

from line 128

129128

130129 Array of content blocks for the user message.

131130

132 - `BetaManagedAgentsTextBlock object { text, type }`

131 - `BetaManagedAgentsTextBlock object`

133132

134133 Regular text content.

135134

from line 136

137136

138137 The text content.

139138

139 minLength: 1

140

140141 - `type: "text"`

141142

142 - `"text"`

143

144 - `BetaManagedAgentsImageBlock object { source, type }`

143 - `BetaManagedAgentsImageBlock object`

145144

146145 Image content specified directly as base64 data or as a reference via a URL.

147146

from line 148

149148

150149 Union type for image source variants.

151150

152 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

151 - `BetaManagedAgentsBase64ImageSource object`

153152

154153 Base64-encoded image data.

155154

from line 156

157156

158157 Base64-encoded image data.

159158

159 minLength: 1

160

160161 - `media_type: string`

161162

162163 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

163164

165 minLength: 1

166

164167 - `type: "base64"`

165168

166 - `"base64"`

167

168 - `BetaManagedAgentsURLImageSource object { type, url }`

169 - `BetaManagedAgentsURLImageSource object`

169170

170171 Image referenced by URL.

171172

172173 - `type: "url"`

173174

174 - `"url"`

175

176175 - `url: string`

177176

178177 URL of the image to fetch.

179178

180 - `BetaManagedAgentsFileImageSource object { file_id, type }`

179 minLength: 1

180

181 - `BetaManagedAgentsFileImageSource object`

181182

182183 Image referenced by file ID.

183184

from line 186

185186

186187 ID of a previously uploaded file.

187188

189 minLength: 1

190

188191 - `type: "file"`

189192

190 - `"file"`

191

192193 - `type: "image"`

193194

194 - `"image"`

195

196 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

195 - `BetaManagedAgentsDocumentBlock object`

197196

198197 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

199198

from line 200

201200

202201 Union type for document source variants.

203202

204 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

203 - `BetaManagedAgentsBase64DocumentSource object`

205204

206205 Base64-encoded document data.

207206

from line 208

209208

210209 Base64-encoded document data.

211210

211 minLength: 1

212

212213 - `media_type: string`

213214

214215 MIME type of the document (e.g., "application/pdf").

215216

217 minLength: 1

218

216219 - `type: "base64"`

217220

218 - `"base64"`

219

220 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

221 - `BetaManagedAgentsPlainTextDocumentSource object`

221222

222223 Plain text document content.

223224

from line 226

225226

226227 The plain text content.

227228

229 minLength: 1

230

228231 - `media_type: "text/plain"`

229232

230233 MIME type of the text content. Must be "text/plain".

231234

232 - `"text/plain"`

233

234235 - `type: "text"`

235236

236 - `"text"`

237

238 - `BetaManagedAgentsURLDocumentSource object { type, url }`

237 - `BetaManagedAgentsURLDocumentSource object`

239238

240239 Document referenced by URL.

241240

242241 - `type: "url"`

243242

244 - `"url"`

245

246243 - `url: string`

247244

248245 URL of the document to fetch.

249246

250 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

247 minLength: 1

248

249 - `BetaManagedAgentsFileDocumentSource object`

251250

252251 Document referenced by file ID.

253252

from line 254

255254

256255 ID of a previously uploaded file.

257256

257 minLength: 1

258

258259 - `type: "file"`

259260

260 - `"file"`

261

262261 - `type: "document"`

263262

264 - `"document"`

265

266263 - `context: optional string or null`

267264

268265 Additional context about the document for the model.

from line 268

271268

272269 The title of the document.

273270

274 - `BetaManagedAgentsRedactedBlock object { type }`

271 - `BetaManagedAgentsRedactedBlock object`

275272

276273 Placeholder for content withheld by Anthropic model policy.

277274

278275 - `type: "redacted"`

279276

280 - `"redacted"`

281

282277 - `type: "user.message"`

283278

284 - `"user.message"`

285

286 - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`

279 - `BetaManagedAgentsUserDefineOutcomeEventParams object`

287280

288281 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

289282

from line 288

295288

296289 Rubric for grading the quality of an outcome.

297290

298 - `BetaManagedAgentsFileRubricParams object { file_id, type }`

291 - `BetaManagedAgentsFileRubricParams object`

299292

300293 Rubric referenced by a file uploaded via the Files API.

301294

from line 298

305298

306299 - `type: "file"`

307300

308 - `"file"`

309

310 - `BetaManagedAgentsTextRubricParams object { content, type }`

301 - `BetaManagedAgentsTextRubricParams object`

311302

312303 Rubric content provided inline as text.

313304

from line 306

315306

316307 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.

317308

309 maxLength: 262144

310

318311 - `type: "text"`

319312

320 - `"text"`

321

322313 - `type: "user.define_outcome"`

323314

324 - `"user.define_outcome"`

325

326315 - `max_iterations: optional number or null`

327316

328317 Eval→revision cycles before giving up. Default 3, max 20.

329318

330 - `BetaManagedAgentsSystemMessageEventParams object { content, type }`

319 format: int32

320

321 - `BetaManagedAgentsSystemMessageEventParams object`

331322

332323 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.

333324

from line 330

339330

340331 The text content.

341332

333 minLength: 1

334

342335 - `type: "text"`

343336

344 - `"text"`

345

346337 - `type: "system.message"`

347338

348 - `"system.message"`

349

350339- `name: string`

351340

352341 Human-readable name for the deployment.

353342

343 minLength: 1, maxLength: 256

344

354345- `budget: optional BetaManagedAgentsBudgetLimit or null`

355346

356347 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.

from line 358

367358

368359 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.

369360

370 - `"USD"`

371

372361 - `type: "limit"`

373362

374 - `"limit"`

375

376363- `description: optional string or null`

377364

378365 Description of what the deployment does.

379366

367 maxLength: 2048

368

380369- `metadata: optional map[string]`

381370

382371 Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

from line 374

385374

386375 Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.

387376

388 - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }`

377 - `BetaManagedAgentsGitHubRepositoryResourceParams object`

389378

390379 Mount a GitHub repository into the session's container.

391380

from line 382

393382

394383 GitHub authorization token used to clone the repository.

395384

385 minLength: 1, maxLength: 4096

386

396387 - `type: "github_repository"`

397388

398 - `"github_repository"`

399

400389 - `url: string`

401390

402391 Github URL of the repository

403392

393 minLength: 1, maxLength: 2048

394

404395 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`

405396

406397 Branch or commit to check out. Defaults to the repository's default branch.

407398

408 - `BetaManagedAgentsBranchCheckout object { name, type }`

399 - `BetaManagedAgentsBranchCheckout object`

409400

410401 - `name: string`

411402

412403 Branch name to check out.

413404

405 minLength: 1, maxLength: 255

406

414407 - `type: "branch"`

415408

416 - `"branch"`

417

418 - `BetaManagedAgentsCommitCheckout object { sha, type }`

409 - `BetaManagedAgentsCommitCheckout object`

419410

420411 - `sha: string`

421412

422413 Full commit SHA to check out.

423414

415 minLength: 7, maxLength: 64

416

424417 - `type: "commit"`

425418

426 - `"commit"`

427

428419 - `mount_path: optional string or null`

429420

430421 Mount path in the container. Defaults to `/workspace/<repo-name>`.

431422

432 - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }`

423 minLength: 1, maxLength: 4096

424

425 - `BetaManagedAgentsFileResourceParams object`

433426

434427 Mount a file uploaded via the Files API into the session.

435428

from line 430

437430

438431 ID of a previously uploaded file.

439432

433 minLength: 1, maxLength: 128

434

440435 - `type: "file"`

441436

442 - `"file"`

443

444437 - `mount_path: optional string or null`

445438

446439 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

447440

448 - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }`

441 minLength: 1, maxLength: 4096

442

443 - `BetaManagedAgentsMemoryStoreResourceParam object`

449444

450445 Parameters for attaching a memory store to an agent session.

451446

from line 450

455450

456451 - `type: "memory_store"`

457452

458 - `"memory_store"`

459

460453 - `access: optional "read_write" or "read_only" or null`

461454

462455 Access mode for an attached memory store.

from line 462

469462

470463 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.

471464

465 maxLength: 4096

466

472467- `schedule: optional BetaManagedAgentsScheduleParams or null`

473468

474469 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

from line 472

477472

478473 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).

479474

475 minLength: 1, maxLength: 256

476

480477 - `timezone: string`

481478

482479 Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

483480

481 minLength: 1

482

484483 - `type: "cron"`

485484

486 - `"cron"`

487

488485- `vault_ids: optional array of string`

489486

490487 Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.

491488

492489### Returns

493490

494- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

491- `BetaManagedAgentsDeployment object`

495492

496493 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.

497494

from line 504

507504

508505 - `type: "agent"`

509506

510 - `"agent"`

511

512507 - `version: number`

513508

509 format: int32

510

514511 - `archived_at: string or null`

515512

516513 A timestamp in RFC 3339 format

517514

515 format: date-time

516

518517 - `created_at: string`

519518

520519 A timestamp in RFC 3339 format

521520

521 format: date-time

522

522523 - `description: string or null`

523524

524525 Description of what the deployment does.

from line 532

531532

532533 Events sent to each session immediately after creation.

533534

534 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

535 - `BetaManagedAgentsDeploymentUserMessageEvent object`

535536

536537 A user message sent to the session.

537538

from line 540

539540

540541 Array of content blocks for the user message.

541542

542 - `BetaManagedAgentsTextBlock object { text, type }`

543 - `BetaManagedAgentsTextBlock object`

543544

544545 Regular text content.

545546

from line 548

547548

548549 The text content.

549550

551 minLength: 1

552

550553 - `type: "text"`

551554

552 - `"text"`

553

554 - `BetaManagedAgentsImageBlock object { source, type }`

555 - `BetaManagedAgentsImageBlock object`

555556

556557 Image content specified directly as base64 data or as a reference via a URL.

557558

from line 560

559560

560561 Union type for image source variants.

561562

562 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

563 - `BetaManagedAgentsBase64ImageSource object`

563564

564565 Base64-encoded image data.

565566

from line 568

567568

568569 Base64-encoded image data.

569570

571 minLength: 1

572

570573 - `media_type: string`

571574

572575 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

573576

577 minLength: 1

578

574579 - `type: "base64"`

575580

576 - `"base64"`

577

578 - `BetaManagedAgentsURLImageSource object { type, url }`

581 - `BetaManagedAgentsURLImageSource object`

579582

580583 Image referenced by URL.

581584

582585 - `type: "url"`

583586

584 - `"url"`

585

586587 - `url: string`

587588

588589 URL of the image to fetch.

589590

590 - `BetaManagedAgentsFileImageSource object { file_id, type }`

591 minLength: 1

592

593 - `BetaManagedAgentsFileImageSource object`

591594

592595 Image referenced by file ID.

593596

from line 598

595598

596599 ID of a previously uploaded file.

597600

601 minLength: 1

602

598603 - `type: "file"`

599604

600 - `"file"`

601

602605 - `type: "image"`

603606

604 - `"image"`

605

606 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

607 - `BetaManagedAgentsDocumentBlock object`

607608

608609 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

609610

from line 612

611612

612613 Union type for document source variants.

613614

614 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

615 - `BetaManagedAgentsBase64DocumentSource object`

615616

616617 Base64-encoded document data.

617618

from line 620

619620

620621 Base64-encoded document data.

621622

623 minLength: 1

624

622625 - `media_type: string`

623626

624627 MIME type of the document (e.g., "application/pdf").

625628

629 minLength: 1

630

626631 - `type: "base64"`

627632

628 - `"base64"`

629

630 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

633 - `BetaManagedAgentsPlainTextDocumentSource object`

631634

632635 Plain text document content.

633636

from line 638

635638

636639 The plain text content.

637640

641 minLength: 1

642

638643 - `media_type: "text/plain"`

639644

640645 MIME type of the text content. Must be "text/plain".

641646

642 - `"text/plain"`

643

644647 - `type: "text"`

645648

646 - `"text"`

647

648 - `BetaManagedAgentsURLDocumentSource object { type, url }`

649 - `BetaManagedAgentsURLDocumentSource object`

649650

650651 Document referenced by URL.

651652

652653 - `type: "url"`

653654

654 - `"url"`

655

656655 - `url: string`

657656

658657 URL of the document to fetch.

659658

660 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

659 minLength: 1

660

661 - `BetaManagedAgentsFileDocumentSource object`

661662

662663 Document referenced by file ID.

663664

from line 666

665666

666667 ID of a previously uploaded file.

667668

669 minLength: 1

670

668671 - `type: "file"`

669672

670 - `"file"`

671

672673 - `type: "document"`

673674

674 - `"document"`

675

676675 - `context: optional string or null`

677676

678677 Additional context about the document for the model.

from line 680

681680

682681 The title of the document.

683682

684 - `BetaManagedAgentsRedactedBlock object { type }`

683 - `BetaManagedAgentsRedactedBlock object`

685684

686685 Placeholder for content withheld by Anthropic model policy.

687686

688687 - `type: "redacted"`

689688

690 - `"redacted"`

691

692689 - `type: "user.message"`

693690

694 - `"user.message"`

695

696 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

691 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

697692

698693 An outcome the agent should work toward. The agent begins work on receipt.

699694

from line 700

705700

706701 Rubric for grading the quality of an outcome.

707702

708 - `BetaManagedAgentsFileRubric object { file_id, type }`

703 - `BetaManagedAgentsFileRubric object`

709704

710705 Rubric referenced by a file uploaded via the Files API.

711706

from line 710

715710

716711 - `type: "file"`

717712

718 - `"file"`

719

720 - `BetaManagedAgentsTextRubric object { content, type }`

713 - `BetaManagedAgentsTextRubric object`

721714

722715 Rubric content provided inline as text.

723716

from line 720

727720

728721 - `type: "text"`

729722

730 - `"text"`

731

732723 - `type: "user.define_outcome"`

733724

734 - `"user.define_outcome"`

735

736725 - `max_iterations: optional number or null`

737726

738727 Eval→revision cycles before giving up. Default 3, max 20.

739728

740 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

729 format: int32

730

731 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

741732

742733 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.

743734

from line 740

749740

750741 The text content.

751742

743 minLength: 1

744

752745 - `type: "text"`

753746

754 - `"text"`

755

756747 - `type: "system.message"`

757748

758 - `"system.message"`

759

760749 - `metadata: map[string]`

761750

762751 Arbitrary key-value metadata. Maximum 16 pairs.

from line 758

769758

770759 Why a deployment is paused. Non-null exactly when `status` is `paused`.

771760

772 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

761 - `BetaManagedAgentsManualDeploymentPausedReason object`

773762

774763 The caller invoked the pause endpoint on the deployment.

775764

776765 - `type: "manual"`

777766

778 - `"manual"`

779

780 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

767 - `BetaManagedAgentsErrorDeploymentPausedReason object`

781768

782769 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

783770

from line 772

785772

786773 The error that triggered an auto-pause. Matches the failed run's `error.type`.

787774

788 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

775 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

789776

790777 The deployment's environment was archived.

791778

792779 - `type: "environment_archived_error"`

793780

794 - `"environment_archived_error"`

795

796 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

781 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

797782

798783 The deployment's agent was archived.

799784

800785 - `type: "agent_archived_error"`

801786

802 - `"agent_archived_error"`

803

804 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

787 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

805788

806789 The deployment's environment no longer exists.

807790

808791 - `type: "environment_not_found_error"`

809792

810 - `"environment_not_found_error"`

811

812 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

793 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

813794

814795 A vault referenced by the deployment no longer exists.

815796

816797 - `type: "vault_not_found_error"`

817798

818 - `"vault_not_found_error"`

819

820 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

799 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

821800

822801 A file resource referenced by the deployment no longer exists.

823802

824803 - `type: "file_not_found_error"`

825804

826 - `"file_not_found_error"`

827

828 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

805 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

829806

830807 A referenced resource no longer exists and its kind was not reported.

831808

832809 - `type: "session_resource_not_found_error"`

833810

834 - `"session_resource_not_found_error"`

835

836 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

811 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

837812

838813 The deployment's workspace was archived.

839814

840815 - `type: "workspace_archived_error"`

841816

842 - `"workspace_archived_error"`

843

844 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

817 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

845818

846819 The deployment's organization is disabled.

847820

848821 - `type: "organization_disabled_error"`

849822

850 - `"organization_disabled_error"`

851

852 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

823 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

853824

854825 A memory store referenced by the deployment is archived.

855826

856827 - `type: "memory_store_archived_error"`

857828

858 - `"memory_store_archived_error"`

859

860 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

829 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

861830

862831 A skill referenced by the deployment's agent no longer exists.

863832

864833 - `type: "skill_not_found_error"`

865834

866 - `"skill_not_found_error"`

867

868 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

835 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

869836

870837 A vault referenced by the deployment is archived.

871838

872839 - `type: "vault_archived_error"`

873840

874 - `"vault_archived_error"`

875

876 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

841 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

877842

878843 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

879844

880845 - `type: "unknown_error"`

881846

882 - `"unknown_error"`

883

884 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

847 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

885848

886849 The deployment configures resources, but its environment is self-hosted and cannot mount them.

887850

888851 - `type: "self_hosted_resources_unsupported_error"`

889852

890 - `"self_hosted_resources_unsupported_error"`

891

892 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

853 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

893854

894855 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

895856

896857 - `type: "mcp_egress_blocked_error"`

897858

898 - `"mcp_egress_blocked_error"`

899

900859 - `type: "error"`

901860

902 - `"error"`

903

904861 - `resources: array of BetaManagedAgentsSessionResourceConfig`

905862

906863 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

907864

908 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

865 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

909866

910867 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

911868

912869 - `type: "github_repository"`

913870

914 - `"github_repository"`

915

916871 - `url: string`

917872

918873 Github URL of the repository

from line 876

921876

922877 Branch or commit to check out. Defaults to the repository's default branch.

923878

924 - `BetaManagedAgentsBranchCheckout object { name, type }`

879 - `BetaManagedAgentsBranchCheckout object`

925880

926881 - `name: string`

927882

928883 Branch name to check out.

929884

885 minLength: 1, maxLength: 255

886

930887 - `type: "branch"`

931888

932 - `"branch"`

933

934 - `BetaManagedAgentsCommitCheckout object { sha, type }`

889 - `BetaManagedAgentsCommitCheckout object`

935890

936891 - `sha: string`

937892

938893 Full commit SHA to check out.

939894

895 minLength: 7, maxLength: 64

896

940897 - `type: "commit"`

941898

942 - `"commit"`

943

944899 - `mount_path: optional string or null`

945900

946901 Mount path in the container. Defaults to `/workspace/<repo-name>`.

947902

948 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

903 - `BetaManagedAgentsFileResourceConfig object`

949904

950905 A file mounted into each session's container.

951906

from line 910

955910

956911 - `type: "file"`

957912

958 - `"file"`

959

960913 - `mount_path: optional string or null`

961914

962915 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

963916

964 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

917 - `BetaManagedAgentsMemoryStoreResourceConfig object`

965918

966919 A memory store attached to each session created from this deployment.

967920

from line 924

971924

972925 - `type: "memory_store"`

973926

974 - `"memory_store"`

975

976927 - `access: optional "read_write" or "read_only" or null`

977928

978929 Access mode for an attached memory store.

from line 944

993944

994945 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).

995946

947 minLength: 1, maxLength: 256

948

996949 - `timezone: string`

997950

998951 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

999952

953 minLength: 1

954

1000955 - `type: "cron"`

1001956

1002 - `"cron"`

1003

1004957 - `last_run_at: optional string or null`

1005958

1006959 A timestamp in RFC 3339 format

1007960

961 format: date-time

962

1008963 - `upcoming_runs_at: optional array of string`

1009964

1010965 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 974

1019974

1020975 - `type: "deployment"`

1021976

1022 - `"deployment"`

1023

1024977 - `updated_at: string`

1025978

1026979 A timestamp in RFC 3339 format

1027980

981 format: date-time

982

1028983 - `vault_ids: array of string`

1029984

1030985 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 1000

10451000

10461001 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.

10471002

1048 - `"USD"`

1049

10501003 - `type: "limit"`

10511004

1052 - `"limit"`

1053

10541005### Example

10551006

1056```http

1007```bash

10571008curl https://api.anthropic.com/v1/deployments \

10581009 -H 'Content-Type: application/json' \

10591010 -H 'anthropic-version: 2023-06-01' \

from line 1028

10771028 }'

10781029```

10791030

1080#### Response

1031#### Response (200)

10811032

10821033```json

10831034{

from line 1097

11461097

11471098## List Deployments

11481099

1149**get** `/v1/deployments`

1100**GET** `/v1/deployments`

11501101

11511102List Deployments

11521103

1153### Query Parameters

1104### Query parameters

11541105

11551106- `agent_id: optional string`

11561107

from line 1111

11601111

11611112 Return deployments created at or after this time (inclusive).

11621113

1114 format: date-time

1115

11631116- `"created_at[lte]": optional string`

11641117

11651118 Return deployments created at or before this time (inclusive).

11661119

1120 format: date-time

1121

11671122- `include_archived: optional boolean`

11681123

11691124 When true, includes archived deployments. Default: false (exclude archived).

from line 1127

11721127

11731128 Maximum results per page. Default 20, maximum 100.

11741129

1130 format: int32

1131

11751132- `page: optional string`

11761133

11771134 Opaque pagination cursor.

from line 1141

11841141

11851142 - `"paused"`

11861143

1187### Header Parameters

1144### Headers

11881145

11891146- `"anthropic-beta": optional array of AnthropicBeta`

11901147

from line 1237

12801237

12811238 - `type: "agent"`

12821239

1283 - `"agent"`

1284

12851240 - `version: number`

12861241

1242 format: int32

1243

12871244 - `archived_at: string or null`

12881245

12891246 A timestamp in RFC 3339 format

12901247

1248 format: date-time

1249

12911250 - `created_at: string`

12921251

12931252 A timestamp in RFC 3339 format

12941253

1254 format: date-time

1255

12951256 - `description: string or null`

12961257

12971258 Description of what the deployment does.

from line 1265

13041265

13051266 Events sent to each session immediately after creation.

13061267

1307 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

1268 - `BetaManagedAgentsDeploymentUserMessageEvent object`

13081269

13091270 A user message sent to the session.

13101271

from line 1273

13121273

13131274 Array of content blocks for the user message.

13141275

1315 - `BetaManagedAgentsTextBlock object { text, type }`

1276 - `BetaManagedAgentsTextBlock object`

13161277

13171278 Regular text content.

13181279

from line 1281

13201281

13211282 The text content.

13221283

1284 minLength: 1

1285

13231286 - `type: "text"`

13241287

1325 - `"text"`

1326

1327 - `BetaManagedAgentsImageBlock object { source, type }`

1288 - `BetaManagedAgentsImageBlock object`

13281289

13291290 Image content specified directly as base64 data or as a reference via a URL.

13301291

from line 1293

13321293

13331294 Union type for image source variants.

13341295

1335 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

1296 - `BetaManagedAgentsBase64ImageSource object`

13361297

13371298 Base64-encoded image data.

13381299

from line 1301

13401301

13411302 Base64-encoded image data.

13421303

1304 minLength: 1

1305

13431306 - `media_type: string`

13441307

13451308 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

13461309

1310 minLength: 1

1311

13471312 - `type: "base64"`

13481313

1349 - `"base64"`

1350

1351 - `BetaManagedAgentsURLImageSource object { type, url }`

1314 - `BetaManagedAgentsURLImageSource object`

13521315

13531316 Image referenced by URL.

13541317

13551318 - `type: "url"`

13561319

1357 - `"url"`

1358

13591320 - `url: string`

13601321

13611322 URL of the image to fetch.

13621323

1363 - `BetaManagedAgentsFileImageSource object { file_id, type }`

1324 minLength: 1

1325

1326 - `BetaManagedAgentsFileImageSource object`

13641327

13651328 Image referenced by file ID.

13661329

from line 1331

13681331

13691332 ID of a previously uploaded file.

13701333

1334 minLength: 1

1335

13711336 - `type: "file"`

13721337

1373 - `"file"`

1374

13751338 - `type: "image"`

13761339

1377 - `"image"`

1378

1379 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

1340 - `BetaManagedAgentsDocumentBlock object`

13801341

13811342 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

13821343

from line 1345

13841345

13851346 Union type for document source variants.

13861347

1387 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

1348 - `BetaManagedAgentsBase64DocumentSource object`

13881349

13891350 Base64-encoded document data.

13901351

from line 1353

13921353

13931354 Base64-encoded document data.

13941355

1356 minLength: 1

1357

13951358 - `media_type: string`

13961359

13971360 MIME type of the document (e.g., "application/pdf").

13981361

1362 minLength: 1

1363

13991364 - `type: "base64"`

14001365

1401 - `"base64"`

1402

1403 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

1366 - `BetaManagedAgentsPlainTextDocumentSource object`

14041367

14051368 Plain text document content.

14061369

from line 1371

14081371

14091372 The plain text content.

14101373

1374 minLength: 1

1375

14111376 - `media_type: "text/plain"`

14121377

14131378 MIME type of the text content. Must be "text/plain".

14141379

1415 - `"text/plain"`

1416

14171380 - `type: "text"`

14181381

1419 - `"text"`

1420

1421 - `BetaManagedAgentsURLDocumentSource object { type, url }`

1382 - `BetaManagedAgentsURLDocumentSource object`

14221383

14231384 Document referenced by URL.

14241385

14251386 - `type: "url"`

14261387

1427 - `"url"`

1428

14291388 - `url: string`

14301389

14311390 URL of the document to fetch.

14321391

1433 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

1392 minLength: 1

1393

1394 - `BetaManagedAgentsFileDocumentSource object`

14341395

14351396 Document referenced by file ID.

14361397

from line 1399

14381399

14391400 ID of a previously uploaded file.

14401401

1402 minLength: 1

1403

14411404 - `type: "file"`

14421405

1443 - `"file"`

1444

14451406 - `type: "document"`

14461407

1447 - `"document"`

1448

14491408 - `context: optional string or null`

14501409

14511410 Additional context about the document for the model.

from line 1413

14541413

14551414 The title of the document.

14561415

1457 - `BetaManagedAgentsRedactedBlock object { type }`

1416 - `BetaManagedAgentsRedactedBlock object`

14581417

14591418 Placeholder for content withheld by Anthropic model policy.

14601419

14611420 - `type: "redacted"`

14621421

1463 - `"redacted"`

1464

14651422 - `type: "user.message"`

14661423

1467 - `"user.message"`

1468

1469 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

1424 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

14701425

14711426 An outcome the agent should work toward. The agent begins work on receipt.

14721427

from line 1433

14781433

14791434 Rubric for grading the quality of an outcome.

14801435

1481 - `BetaManagedAgentsFileRubric object { file_id, type }`

1436 - `BetaManagedAgentsFileRubric object`

14821437

14831438 Rubric referenced by a file uploaded via the Files API.

14841439

from line 1443

14881443

14891444 - `type: "file"`

14901445

1491 - `"file"`

1492

1493 - `BetaManagedAgentsTextRubric object { content, type }`

1446 - `BetaManagedAgentsTextRubric object`

14941447

14951448 Rubric content provided inline as text.

14961449

from line 1453

15001453

15011454 - `type: "text"`

15021455

1503 - `"text"`

1504

15051456 - `type: "user.define_outcome"`

15061457

1507 - `"user.define_outcome"`

1508

15091458 - `max_iterations: optional number or null`

15101459

15111460 Eval→revision cycles before giving up. Default 3, max 20.

15121461

1513 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

1462 format: int32

1463

1464 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

15141465

15151466 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.

15161467

from line 1473

15221473

15231474 The text content.

15241475

1476 minLength: 1

1477

15251478 - `type: "text"`

15261479

1527 - `"text"`

1528

15291480 - `type: "system.message"`

15301481

1531 - `"system.message"`

1532

15331482 - `metadata: map[string]`

15341483

15351484 Arbitrary key-value metadata. Maximum 16 pairs.

from line 1491

15421491

15431492 Why a deployment is paused. Non-null exactly when `status` is `paused`.

15441493

1545 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

1494 - `BetaManagedAgentsManualDeploymentPausedReason object`

15461495

15471496 The caller invoked the pause endpoint on the deployment.

15481497

15491498 - `type: "manual"`

15501499

1551 - `"manual"`

1552

1553 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

1500 - `BetaManagedAgentsErrorDeploymentPausedReason object`

15541501

15551502 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

15561503

from line 1505

15581505

15591506 The error that triggered an auto-pause. Matches the failed run's `error.type`.

15601507

1561 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

1508 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

15621509

15631510 The deployment's environment was archived.

15641511

15651512 - `type: "environment_archived_error"`

15661513

1567 - `"environment_archived_error"`

1568

1569 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

1514 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

15701515

15711516 The deployment's agent was archived.

15721517

15731518 - `type: "agent_archived_error"`

15741519

1575 - `"agent_archived_error"`

1576

1577 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

1520 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

15781521

15791522 The deployment's environment no longer exists.

15801523

15811524 - `type: "environment_not_found_error"`

15821525

1583 - `"environment_not_found_error"`

1584

1585 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

1526 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

15861527

15871528 A vault referenced by the deployment no longer exists.

15881529

15891530 - `type: "vault_not_found_error"`

15901531

1591 - `"vault_not_found_error"`

1592

1593 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

1532 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

15941533

15951534 A file resource referenced by the deployment no longer exists.

15961535

15971536 - `type: "file_not_found_error"`

15981537

1599 - `"file_not_found_error"`

1600

1601 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

1538 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

16021539

16031540 A referenced resource no longer exists and its kind was not reported.

16041541

16051542 - `type: "session_resource_not_found_error"`

16061543

1607 - `"session_resource_not_found_error"`

1608

1609 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

1544 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

16101545

16111546 The deployment's workspace was archived.

16121547

16131548 - `type: "workspace_archived_error"`

16141549

1615 - `"workspace_archived_error"`

1616

1617 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

1550 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

16181551

16191552 The deployment's organization is disabled.

16201553

16211554 - `type: "organization_disabled_error"`

16221555

1623 - `"organization_disabled_error"`

1624

1625 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

1556 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

16261557

16271558 A memory store referenced by the deployment is archived.

16281559

16291560 - `type: "memory_store_archived_error"`

16301561

1631 - `"memory_store_archived_error"`

1632

1633 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

1562 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

16341563

16351564 A skill referenced by the deployment's agent no longer exists.

16361565

16371566 - `type: "skill_not_found_error"`

16381567

1639 - `"skill_not_found_error"`

1640

1641 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

1568 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

16421569

16431570 A vault referenced by the deployment is archived.

16441571

16451572 - `type: "vault_archived_error"`

16461573

1647 - `"vault_archived_error"`

1648

1649 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

1574 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

16501575

16511576 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

16521577

16531578 - `type: "unknown_error"`

16541579

1655 - `"unknown_error"`

1656

1657 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

1580 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

16581581

16591582 The deployment configures resources, but its environment is self-hosted and cannot mount them.

16601583

16611584 - `type: "self_hosted_resources_unsupported_error"`

16621585

1663 - `"self_hosted_resources_unsupported_error"`

1664

1665 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

1586 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

16661587

16671588 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

16681589

16691590 - `type: "mcp_egress_blocked_error"`

16701591

1671 - `"mcp_egress_blocked_error"`

1672

16731592 - `type: "error"`

16741593

1675 - `"error"`

1676

16771594 - `resources: array of BetaManagedAgentsSessionResourceConfig`

16781595

16791596 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

16801597

1681 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

1598 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

16821599

16831600 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

16841601

16851602 - `type: "github_repository"`

16861603

1687 - `"github_repository"`

1688

16891604 - `url: string`

16901605

16911606 Github URL of the repository

from line 1609

16941609

16951610 Branch or commit to check out. Defaults to the repository's default branch.

16961611

1697 - `BetaManagedAgentsBranchCheckout object { name, type }`

1612 - `BetaManagedAgentsBranchCheckout object`

16981613

16991614 - `name: string`

17001615

17011616 Branch name to check out.

17021617

1618 minLength: 1, maxLength: 255

1619

17031620 - `type: "branch"`

17041621

1705 - `"branch"`

1706

1707 - `BetaManagedAgentsCommitCheckout object { sha, type }`

1622 - `BetaManagedAgentsCommitCheckout object`

17081623

17091624 - `sha: string`

17101625

17111626 Full commit SHA to check out.

17121627

1628 minLength: 7, maxLength: 64

1629

17131630 - `type: "commit"`

17141631

1715 - `"commit"`

1716

17171632 - `mount_path: optional string or null`

17181633

17191634 Mount path in the container. Defaults to `/workspace/<repo-name>`.

17201635

1721 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

1636 - `BetaManagedAgentsFileResourceConfig object`

17221637

17231638 A file mounted into each session's container.

17241639

from line 1643

17281643

17291644 - `type: "file"`

17301645

1731 - `"file"`

1732

17331646 - `mount_path: optional string or null`

17341647

17351648 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

17361649

1737 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

1650 - `BetaManagedAgentsMemoryStoreResourceConfig object`

17381651

17391652 A memory store attached to each session created from this deployment.

17401653

from line 1657

17441657

17451658 - `type: "memory_store"`

17461659

1747 - `"memory_store"`

1748

17491660 - `access: optional "read_write" or "read_only" or null`

17501661

17511662 Access mode for an attached memory store.

from line 1677

17661677

17671678 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).

17681679

1680 minLength: 1, maxLength: 256

1681

17691682 - `timezone: string`

17701683

17711684 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

17721685

1686 minLength: 1

1687

17731688 - `type: "cron"`

17741689

1775 - `"cron"`

1776

17771690 - `last_run_at: optional string or null`

17781691

17791692 A timestamp in RFC 3339 format

17801693

1694 format: date-time

1695

17811696 - `upcoming_runs_at: optional array of string`

17821697

17831698 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 1707

17921707

17931708 - `type: "deployment"`

17941709

1795 - `"deployment"`

1796

17971710 - `updated_at: string`

17981711

17991712 A timestamp in RFC 3339 format

18001713

1714 format: date-time

1715

18011716 - `vault_ids: array of string`

18021717

18031718 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 1733

18181733

18191734 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.

18201735

1821 - `"USD"`

1822

18231736 - `type: "limit"`

18241737

1825 - `"limit"`

1826

18271738- `next_page: optional string or null`

18281739

18291740 Opaque cursor for the next page. Null when no more results.

18301741

18311742### Example

18321743

1833```http

1744```bash

18341745curl https://api.anthropic.com/v1/deployments \

18351746 -H 'anthropic-version: 2023-06-01' \

18361747 -H 'anthropic-beta: managed-agents-2026-04-01' \

18371748 -H "X-Api-Key: $ANTHROPIC_API_KEY"

18381749```

18391750

1840#### Response

1751#### Response (200)

18411752

18421753```json

18431754{

from line 1822

19111822

19121823## Get Deployment

19131824

1914**get** `/v1/deployments/{deployment_id}`

1825**GET** `/v1/deployments/{deployment_id}`

19151826

19161827Get Deployment

19171828

1918### Path Parameters

1829### Path parameters

19191830

19201831- `deployment_id: string`

19211832

1922### Header Parameters

1833### Headers

19231834

19241835- `"anthropic-beta": optional array of AnthropicBeta`

19251836

from line 1910

19991910

20001911### Returns

20011912

2002- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

1913- `BetaManagedAgentsDeployment object`

20031914

20041915 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.

20051916

from line 1926

20151926

20161927 - `type: "agent"`

20171928

2018 - `"agent"`

2019

20201929 - `version: number`

20211930

1931 format: int32

1932

20221933 - `archived_at: string or null`

20231934

20241935 A timestamp in RFC 3339 format

20251936

1937 format: date-time

1938

20261939 - `created_at: string`

20271940

20281941 A timestamp in RFC 3339 format

20291942

1943 format: date-time

1944

20301945 - `description: string or null`

20311946

20321947 Description of what the deployment does.

from line 1954

20391954

20401955 Events sent to each session immediately after creation.

20411956

2042 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

1957 - `BetaManagedAgentsDeploymentUserMessageEvent object`

20431958

20441959 A user message sent to the session.

20451960

from line 1962

20471962

20481963 Array of content blocks for the user message.

20491964

2050 - `BetaManagedAgentsTextBlock object { text, type }`

1965 - `BetaManagedAgentsTextBlock object`

20511966

20521967 Regular text content.

20531968

from line 1970

20551970

20561971 The text content.

20571972

1973 minLength: 1

1974

20581975 - `type: "text"`

20591976

2060 - `"text"`

2061

2062 - `BetaManagedAgentsImageBlock object { source, type }`

1977 - `BetaManagedAgentsImageBlock object`

20631978

20641979 Image content specified directly as base64 data or as a reference via a URL.

20651980

from line 1982

20671982

20681983 Union type for image source variants.

20691984

2070 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

1985 - `BetaManagedAgentsBase64ImageSource object`

20711986

20721987 Base64-encoded image data.

20731988

from line 1990

20751990

20761991 Base64-encoded image data.

20771992

1993 minLength: 1

1994

20781995 - `media_type: string`

20791996

20801997 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

20811998

1999 minLength: 1

2000

20822001 - `type: "base64"`

20832002

2084 - `"base64"`

2085

2086 - `BetaManagedAgentsURLImageSource object { type, url }`

2003 - `BetaManagedAgentsURLImageSource object`

20872004

20882005 Image referenced by URL.

20892006

20902007 - `type: "url"`

20912008

2092 - `"url"`

2093

20942009 - `url: string`

20952010

20962011 URL of the image to fetch.

20972012

2098 - `BetaManagedAgentsFileImageSource object { file_id, type }`

2013 minLength: 1

2014

2015 - `BetaManagedAgentsFileImageSource object`

20992016

21002017 Image referenced by file ID.

21012018

from line 2020

21032020

21042021 ID of a previously uploaded file.

21052022

2023 minLength: 1

2024

21062025 - `type: "file"`

21072026

2108 - `"file"`

2109

21102027 - `type: "image"`

21112028

2112 - `"image"`

2113

2114 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

2029 - `BetaManagedAgentsDocumentBlock object`

21152030

21162031 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

21172032

from line 2034

21192034

21202035 Union type for document source variants.

21212036

2122 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

2037 - `BetaManagedAgentsBase64DocumentSource object`

21232038

21242039 Base64-encoded document data.

21252040

from line 2042

21272042

21282043 Base64-encoded document data.

21292044

2045 minLength: 1

2046

21302047 - `media_type: string`

21312048

21322049 MIME type of the document (e.g., "application/pdf").

21332050

2051 minLength: 1

2052

21342053 - `type: "base64"`

21352054

2136 - `"base64"`

2137

2138 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

2055 - `BetaManagedAgentsPlainTextDocumentSource object`

21392056

21402057 Plain text document content.

21412058

from line 2060

21432060

21442061 The plain text content.

21452062

2063 minLength: 1

2064

21462065 - `media_type: "text/plain"`

21472066

21482067 MIME type of the text content. Must be "text/plain".

21492068

2150 - `"text/plain"`

2151

21522069 - `type: "text"`

21532070

2154 - `"text"`

2155

2156 - `BetaManagedAgentsURLDocumentSource object { type, url }`

2071 - `BetaManagedAgentsURLDocumentSource object`

21572072

21582073 Document referenced by URL.

21592074

21602075 - `type: "url"`

21612076

2162 - `"url"`

2163

21642077 - `url: string`

21652078

21662079 URL of the document to fetch.

21672080

2168 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

2081 minLength: 1

2082

2083 - `BetaManagedAgentsFileDocumentSource object`

21692084

21702085 Document referenced by file ID.

21712086

from line 2088

21732088

21742089 ID of a previously uploaded file.

21752090

2091 minLength: 1

2092

21762093 - `type: "file"`

21772094

2178 - `"file"`

2179

21802095 - `type: "document"`

21812096

2182 - `"document"`

2183

21842097 - `context: optional string or null`

21852098

21862099 Additional context about the document for the model.

from line 2102

21892102

21902103 The title of the document.

21912104

2192 - `BetaManagedAgentsRedactedBlock object { type }`

2105 - `BetaManagedAgentsRedactedBlock object`

21932106

21942107 Placeholder for content withheld by Anthropic model policy.

21952108

21962109 - `type: "redacted"`

21972110

2198 - `"redacted"`

2199

22002111 - `type: "user.message"`

22012112

2202 - `"user.message"`

2203

2204 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

2113 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

22052114

22062115 An outcome the agent should work toward. The agent begins work on receipt.

22072116

from line 2122

22132122

22142123 Rubric for grading the quality of an outcome.

22152124

2216 - `BetaManagedAgentsFileRubric object { file_id, type }`

2125 - `BetaManagedAgentsFileRubric object`

22172126

22182127 Rubric referenced by a file uploaded via the Files API.

22192128

from line 2132

22232132

22242133 - `type: "file"`

22252134

2226 - `"file"`

2227

2228 - `BetaManagedAgentsTextRubric object { content, type }`

2135 - `BetaManagedAgentsTextRubric object`

22292136

22302137 Rubric content provided inline as text.

22312138

from line 2142

22352142

22362143 - `type: "text"`

22372144

2238 - `"text"`

2239

22402145 - `type: "user.define_outcome"`

22412146

2242 - `"user.define_outcome"`

2243

22442147 - `max_iterations: optional number or null`

22452148

22462149 Eval→revision cycles before giving up. Default 3, max 20.

22472150

2248 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

2151 format: int32

2152

2153 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

22492154

22502155 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.

22512156

from line 2162

22572162

22582163 The text content.

22592164

2165 minLength: 1

2166

22602167 - `type: "text"`

22612168

2262 - `"text"`

2263

22642169 - `type: "system.message"`

22652170

2266 - `"system.message"`

2267

22682171 - `metadata: map[string]`

22692172

22702173 Arbitrary key-value metadata. Maximum 16 pairs.

from line 2180

22772180

22782181 Why a deployment is paused. Non-null exactly when `status` is `paused`.

22792182

2280 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

2183 - `BetaManagedAgentsManualDeploymentPausedReason object`

22812184

22822185 The caller invoked the pause endpoint on the deployment.

22832186

22842187 - `type: "manual"`

22852188

2286 - `"manual"`

2287

2288 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

2189 - `BetaManagedAgentsErrorDeploymentPausedReason object`

22892190

22902191 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

22912192

from line 2194

22932194

22942195 The error that triggered an auto-pause. Matches the failed run's `error.type`.

22952196

2296 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

2197 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

22972198

22982199 The deployment's environment was archived.

22992200

23002201 - `type: "environment_archived_error"`

23012202

2302 - `"environment_archived_error"`

2303

2304 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

2203 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

23052204

23062205 The deployment's agent was archived.

23072206

23082207 - `type: "agent_archived_error"`

23092208

2310 - `"agent_archived_error"`

2311

2312 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

2209 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

23132210

23142211 The deployment's environment no longer exists.

23152212

23162213 - `type: "environment_not_found_error"`

23172214

2318 - `"environment_not_found_error"`

2319

2320 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

2215 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

23212216

23222217 A vault referenced by the deployment no longer exists.

23232218

23242219 - `type: "vault_not_found_error"`

23252220

2326 - `"vault_not_found_error"`

2327

2328 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

2221 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

23292222

23302223 A file resource referenced by the deployment no longer exists.

23312224

23322225 - `type: "file_not_found_error"`

23332226

2334 - `"file_not_found_error"`

2335

2336 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

2227 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

23372228

23382229 A referenced resource no longer exists and its kind was not reported.

23392230

23402231 - `type: "session_resource_not_found_error"`

23412232

2342 - `"session_resource_not_found_error"`

2343

2344 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

2233 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

23452234

23462235 The deployment's workspace was archived.

23472236

23482237 - `type: "workspace_archived_error"`

23492238

2350 - `"workspace_archived_error"`

2351

2352 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

2239 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

23532240

23542241 The deployment's organization is disabled.

23552242

23562243 - `type: "organization_disabled_error"`

23572244

2358 - `"organization_disabled_error"`

2359

2360 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

2245 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

23612246

23622247 A memory store referenced by the deployment is archived.

23632248

23642249 - `type: "memory_store_archived_error"`

23652250

2366 - `"memory_store_archived_error"`

2367

2368 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

2251 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

23692252

23702253 A skill referenced by the deployment's agent no longer exists.

23712254

23722255 - `type: "skill_not_found_error"`

23732256

2374 - `"skill_not_found_error"`

2375

2376 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

2257 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

23772258

23782259 A vault referenced by the deployment is archived.

23792260

23802261 - `type: "vault_archived_error"`

23812262

2382 - `"vault_archived_error"`

2383

2384 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

2263 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

23852264

23862265 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

23872266

23882267 - `type: "unknown_error"`

23892268

2390 - `"unknown_error"`

2391

2392 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

2269 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

23932270

23942271 The deployment configures resources, but its environment is self-hosted and cannot mount them.

23952272

23962273 - `type: "self_hosted_resources_unsupported_error"`

23972274

2398 - `"self_hosted_resources_unsupported_error"`

2399

2400 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

2275 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

24012276

24022277 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

24032278

24042279 - `type: "mcp_egress_blocked_error"`

24052280

2406 - `"mcp_egress_blocked_error"`

2407

24082281 - `type: "error"`

24092282

2410 - `"error"`

2411

24122283 - `resources: array of BetaManagedAgentsSessionResourceConfig`

24132284

24142285 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

24152286

2416 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

2287 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

24172288

24182289 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

24192290

24202291 - `type: "github_repository"`

24212292

2422 - `"github_repository"`

2423

24242293 - `url: string`

24252294

24262295 Github URL of the repository

from line 2298

24292298

24302299 Branch or commit to check out. Defaults to the repository's default branch.

24312300

2432 - `BetaManagedAgentsBranchCheckout object { name, type }`

2301 - `BetaManagedAgentsBranchCheckout object`

24332302

24342303 - `name: string`

24352304

24362305 Branch name to check out.

24372306

2307 minLength: 1, maxLength: 255

2308

24382309 - `type: "branch"`

24392310

2440 - `"branch"`

2441

2442 - `BetaManagedAgentsCommitCheckout object { sha, type }`

2311 - `BetaManagedAgentsCommitCheckout object`

24432312

24442313 - `sha: string`

24452314

24462315 Full commit SHA to check out.

24472316

2317 minLength: 7, maxLength: 64

2318

24482319 - `type: "commit"`

24492320

2450 - `"commit"`

2451

24522321 - `mount_path: optional string or null`

24532322

24542323 Mount path in the container. Defaults to `/workspace/<repo-name>`.

24552324

2456 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

2325 - `BetaManagedAgentsFileResourceConfig object`

24572326

24582327 A file mounted into each session's container.

24592328

from line 2332

24632332

24642333 - `type: "file"`

24652334

2466 - `"file"`

2467

24682335 - `mount_path: optional string or null`

24692336

24702337 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

24712338

2472 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

2339 - `BetaManagedAgentsMemoryStoreResourceConfig object`

24732340

24742341 A memory store attached to each session created from this deployment.

24752342

from line 2346

24792346

24802347 - `type: "memory_store"`

24812348

2482 - `"memory_store"`

2483

24842349 - `access: optional "read_write" or "read_only" or null`

24852350

24862351 Access mode for an attached memory store.

from line 2366

25012366

25022367 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).

25032368

2369 minLength: 1, maxLength: 256

2370

25042371 - `timezone: string`

25052372

25062373 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

25072374

2375 minLength: 1

2376

25082377 - `type: "cron"`

25092378

2510 - `"cron"`

2511

25122379 - `last_run_at: optional string or null`

25132380

25142381 A timestamp in RFC 3339 format

25152382

2383 format: date-time

2384

25162385 - `upcoming_runs_at: optional array of string`

25172386

25182387 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 2396

25272396

25282397 - `type: "deployment"`

25292398

2530 - `"deployment"`

2531

25322399 - `updated_at: string`

25332400

25342401 A timestamp in RFC 3339 format

25352402

2403 format: date-time

2404

25362405 - `vault_ids: array of string`

25372406

25382407 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 2422

25532422

25542423 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.

25552424

2556 - `"USD"`

2557

25582425 - `type: "limit"`

25592426

2560 - `"limit"`

2561

25622427### Example

25632428

2564```http

2429```bash

25652430curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \

25662431 -H 'anthropic-version: 2023-06-01' \

25672432 -H 'anthropic-beta: managed-agents-2026-04-01' \

25682433 -H "X-Api-Key: $ANTHROPIC_API_KEY"

25692434```

25702435

2571#### Response

2436#### Response (200)

25722437

25732438```json

25742439{

from line 2502

26372502

26382503## Update Deployment

26392504

2640**post** `/v1/deployments/{deployment_id}`

2505**POST** `/v1/deployments/{deployment_id}`

26412506

26422507Update Deployment

26432508

2644### Path Parameters

2509### Path parameters

26452510

26462511- `deployment_id: string`

26472512

2648### Header Parameters

2513### Headers

26492514

26502515- `"anthropic-beta": optional array of AnthropicBeta`

26512516

from line 2588

27232588

27242589 - `"mid-conversation-tool-changes-2026-07-01"`

27252590

2726### Body Parameters

2591### Body parameters

27272592

27282593- `agent: optional string or BetaManagedAgentsAgentParams`

27292594

from line 2596

27312596

27322597 - `string`

27332598

2734 - `BetaManagedAgentsAgentParams object { id, type, version }`

2599 - `BetaManagedAgentsAgentParams object`

27352600

27362601 Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version

27372602

from line 2604

27392604

27402605 The `agent` ID.

27412606

2607 minLength: 1, maxLength: 128

2608

27422609 - `type: "agent"`

27432610

2744 - `"agent"`

2745

27462611 - `version: optional number`

27472612

27482613 The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.

27492614

2615 format: int32

2616

27502617- `budget: optional BetaManagedAgentsBudgetLimit or null`

27512618

27522619 A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.

from line 2630

27632630

27642631 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.

27652632

2766 - `"USD"`

2767

27682633 - `type: "limit"`

27692634

2770 - `"limit"`

2771

27722635- `description: optional string or null`

27732636

27742637 Description. Omit to preserve; send empty string or null to clear.

27752638

2639 maxLength: 2048

2640

27762641- `environment_id: optional string`

27772642

27782643 ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.

27792644

2645 maxLength: 128

2646

27802647- `initial_events: optional array of BetaManagedAgentsDeploymentInitialEventParams`

27812648

27822649 Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.

27832650

2784 - `BetaManagedAgentsUserMessageEventParams object { content, type }`

2651 - `BetaManagedAgentsUserMessageEventParams object`

27852652

27862653 Parameters for sending a user message to the session.

27872654

from line 2656

27892656

27902657 Array of content blocks for the user message.

27912658

2792 - `BetaManagedAgentsTextBlock object { text, type }`

2659 - `BetaManagedAgentsTextBlock object`

27932660

27942661 Regular text content.

27952662

from line 2664

27972664

27982665 The text content.

27992666

2667 minLength: 1

2668

28002669 - `type: "text"`

28012670

2802 - `"text"`

2803

2804 - `BetaManagedAgentsImageBlock object { source, type }`

2671 - `BetaManagedAgentsImageBlock object`

28052672

28062673 Image content specified directly as base64 data or as a reference via a URL.

28072674

from line 2676

28092676

28102677 Union type for image source variants.

28112678

2812 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

2679 - `BetaManagedAgentsBase64ImageSource object`

28132680

28142681 Base64-encoded image data.

28152682

from line 2684

28172684

28182685 Base64-encoded image data.

28192686

2687 minLength: 1

2688

28202689 - `media_type: string`

28212690

28222691 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

28232692

2693 minLength: 1

2694

28242695 - `type: "base64"`

28252696

2826 - `"base64"`

2827

2828 - `BetaManagedAgentsURLImageSource object { type, url }`

2697 - `BetaManagedAgentsURLImageSource object`

28292698

28302699 Image referenced by URL.

28312700

28322701 - `type: "url"`

28332702

2834 - `"url"`

2835

28362703 - `url: string`

28372704

28382705 URL of the image to fetch.

28392706

2840 - `BetaManagedAgentsFileImageSource object { file_id, type }`

2707 minLength: 1

2708

2709 - `BetaManagedAgentsFileImageSource object`

28412710

28422711 Image referenced by file ID.

28432712

from line 2714

28452714

28462715 ID of a previously uploaded file.

28472716

2717 minLength: 1

2718

28482719 - `type: "file"`

28492720

2850 - `"file"`

2851

28522721 - `type: "image"`

28532722

2854 - `"image"`

2855

2856 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

2723 - `BetaManagedAgentsDocumentBlock object`

28572724

28582725 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

28592726

from line 2728

28612728

28622729 Union type for document source variants.

28632730

2864 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

2731 - `BetaManagedAgentsBase64DocumentSource object`

28652732

28662733 Base64-encoded document data.

28672734

from line 2736

28692736

28702737 Base64-encoded document data.

28712738

2739 minLength: 1

2740

28722741 - `media_type: string`

28732742

28742743 MIME type of the document (e.g., "application/pdf").

28752744

2745 minLength: 1

2746

28762747 - `type: "base64"`

28772748

2878 - `"base64"`

2879

2880 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

2749 - `BetaManagedAgentsPlainTextDocumentSource object`

28812750

28822751 Plain text document content.

28832752

from line 2754

28852754

28862755 The plain text content.

28872756

2757 minLength: 1

2758

28882759 - `media_type: "text/plain"`

28892760

28902761 MIME type of the text content. Must be "text/plain".

28912762

2892 - `"text/plain"`

2893

28942763 - `type: "text"`

28952764

2896 - `"text"`

2897

2898 - `BetaManagedAgentsURLDocumentSource object { type, url }`

2765 - `BetaManagedAgentsURLDocumentSource object`

28992766

29002767 Document referenced by URL.

29012768

29022769 - `type: "url"`

29032770

2904 - `"url"`

2905

29062771 - `url: string`

29072772

29082773 URL of the document to fetch.

29092774

2910 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

2775 minLength: 1

2776

2777 - `BetaManagedAgentsFileDocumentSource object`

29112778

29122779 Document referenced by file ID.

29132780

from line 2782

29152782

29162783 ID of a previously uploaded file.

29172784

2785 minLength: 1

2786

29182787 - `type: "file"`

29192788

2920 - `"file"`

2921

29222789 - `type: "document"`

29232790

2924 - `"document"`

2925

29262791 - `context: optional string or null`

29272792

29282793 Additional context about the document for the model.

from line 2796

29312796

29322797 The title of the document.

29332798

2934 - `BetaManagedAgentsRedactedBlock object { type }`

2799 - `BetaManagedAgentsRedactedBlock object`

29352800

29362801 Placeholder for content withheld by Anthropic model policy.

29372802

29382803 - `type: "redacted"`

29392804

2940 - `"redacted"`

2941

29422805 - `type: "user.message"`

29432806

2944 - `"user.message"`

2945

2946 - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`

2807 - `BetaManagedAgentsUserDefineOutcomeEventParams object`

29472808

29482809 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

29492810

from line 2816

29552816

29562817 Rubric for grading the quality of an outcome.

29572818

2958 - `BetaManagedAgentsFileRubricParams object { file_id, type }`

2819 - `BetaManagedAgentsFileRubricParams object`

29592820

29602821 Rubric referenced by a file uploaded via the Files API.

29612822

from line 2826

29652826

29662827 - `type: "file"`

29672828

2968 - `"file"`

2969

2970 - `BetaManagedAgentsTextRubricParams object { content, type }`

2829 - `BetaManagedAgentsTextRubricParams object`

29712830

29722831 Rubric content provided inline as text.

29732832

from line 2834

29752834

29762835 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.

29772836

2837 maxLength: 262144

2838

29782839 - `type: "text"`

29792840

2980 - `"text"`

2981

29822841 - `type: "user.define_outcome"`

29832842

2984 - `"user.define_outcome"`

2985

29862843 - `max_iterations: optional number or null`

29872844

29882845 Eval→revision cycles before giving up. Default 3, max 20.

29892846

2990 - `BetaManagedAgentsSystemMessageEventParams object { content, type }`

2847 format: int32

2848

2849 - `BetaManagedAgentsSystemMessageEventParams object`

29912850

29922851 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.

29932852

from line 2858

29992858

30002859 The text content.

30012860

2861 minLength: 1

2862

30022863 - `type: "text"`

30032864

3004 - `"text"`

3005

30062865 - `type: "system.message"`

30072866

3008 - `"system.message"`

3009

30102867- `metadata: optional map[string] or null`

30112868

30122869 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 2872

30152872

30162873 Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

30172874

2875 maxLength: 256

2876

30182877- `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null`

30192878

30202879 Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.

30212880

3022 - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }`

2881 - `BetaManagedAgentsGitHubRepositoryResourceParams object`

30232882

30242883 Mount a GitHub repository into the session's container.

30252884

from line 2886

30272886

30282887 GitHub authorization token used to clone the repository.

30292888

2889 minLength: 1, maxLength: 4096

2890

30302891 - `type: "github_repository"`

30312892

3032 - `"github_repository"`

3033

30342893 - `url: string`

30352894

30362895 Github URL of the repository

30372896

2897 minLength: 1, maxLength: 2048

2898

30382899 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`

30392900

30402901 Branch or commit to check out. Defaults to the repository's default branch.

30412902

3042 - `BetaManagedAgentsBranchCheckout object { name, type }`

2903 - `BetaManagedAgentsBranchCheckout object`

30432904

30442905 - `name: string`

30452906

30462907 Branch name to check out.

30472908

2909 minLength: 1, maxLength: 255

2910

30482911 - `type: "branch"`

30492912

3050 - `"branch"`

3051

3052 - `BetaManagedAgentsCommitCheckout object { sha, type }`

2913 - `BetaManagedAgentsCommitCheckout object`

30532914

30542915 - `sha: string`

30552916

30562917 Full commit SHA to check out.

30572918

2919 minLength: 7, maxLength: 64

2920

30582921 - `type: "commit"`

30592922

3060 - `"commit"`

3061

30622923 - `mount_path: optional string or null`

30632924

30642925 Mount path in the container. Defaults to `/workspace/<repo-name>`.

30652926

3066 - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }`

2927 minLength: 1, maxLength: 4096

2928

2929 - `BetaManagedAgentsFileResourceParams object`

30672930

30682931 Mount a file uploaded via the Files API into the session.

30692932

from line 2934

30712934

30722935 ID of a previously uploaded file.

30732936

2937 minLength: 1, maxLength: 128

2938

30742939 - `type: "file"`

30752940

3076 - `"file"`

3077

30782941 - `mount_path: optional string or null`

30792942

30802943 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

30812944

3082 - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }`

2945 minLength: 1, maxLength: 4096

2946

2947 - `BetaManagedAgentsMemoryStoreResourceParam object`

30832948

30842949 Parameters for attaching a memory store to an agent session.

30852950

from line 2954

30892954

30902955 - `type: "memory_store"`

30912956

3092 - `"memory_store"`

3093

30942957 - `access: optional "read_write" or "read_only" or null`

30952958

30962959 Access mode for an attached memory store.

from line 2966

31032966

31042967 Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.

31052968

2969 maxLength: 4096

2970

31062971- `schedule: optional BetaManagedAgentsScheduleParams or null`

31072972

31082973 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

from line 2976

31112976

31122977 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).

31132978

2979 minLength: 1, maxLength: 256

2980

31142981 - `timezone: string`

31152982

31162983 Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

31172984

2985 minLength: 1

2986

31182987 - `type: "cron"`

31192988

3120 - `"cron"`

3121

31222989- `vault_ids: optional array of string or null`

31232990

31242991 Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.

31252992

31262993### Returns

31272994

3128- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

2995- `BetaManagedAgentsDeployment object`

31292996

31302997 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.

31312998

from line 3008

31413008

31423009 - `type: "agent"`

31433010

3144 - `"agent"`

3145

31463011 - `version: number`

31473012

3013 format: int32

3014

31483015 - `archived_at: string or null`

31493016

31503017 A timestamp in RFC 3339 format

31513018

3019 format: date-time

3020

31523021 - `created_at: string`

31533022

31543023 A timestamp in RFC 3339 format

31553024

3025 format: date-time

3026

31563027 - `description: string or null`

31573028

31583029 Description of what the deployment does.

from line 3036

31653036

31663037 Events sent to each session immediately after creation.

31673038

3168 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

3039 - `BetaManagedAgentsDeploymentUserMessageEvent object`

31693040

31703041 A user message sent to the session.

31713042

from line 3044

31733044

31743045 Array of content blocks for the user message.

31753046

3176 - `BetaManagedAgentsTextBlock object { text, type }`

3047 - `BetaManagedAgentsTextBlock object`

31773048

31783049 Regular text content.

31793050

from line 3052

31813052

31823053 The text content.

31833054

3055 minLength: 1

3056

31843057 - `type: "text"`

31853058

3186 - `"text"`

3187

3188 - `BetaManagedAgentsImageBlock object { source, type }`

3059 - `BetaManagedAgentsImageBlock object`

31893060

31903061 Image content specified directly as base64 data or as a reference via a URL.

31913062

from line 3064

31933064

31943065 Union type for image source variants.

31953066

3196 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

3067 - `BetaManagedAgentsBase64ImageSource object`

31973068

31983069 Base64-encoded image data.

31993070

from line 3072

32013072

32023073 Base64-encoded image data.

32033074

3075 minLength: 1

3076

32043077 - `media_type: string`

32053078

32063079 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

32073080

3081 minLength: 1

3082

32083083 - `type: "base64"`

32093084

3210 - `"base64"`

3211

3212 - `BetaManagedAgentsURLImageSource object { type, url }`

3085 - `BetaManagedAgentsURLImageSource object`

32133086

32143087 Image referenced by URL.

32153088

32163089 - `type: "url"`

32173090

3218 - `"url"`

3219

32203091 - `url: string`

32213092

32223093 URL of the image to fetch.

32233094

3224 - `BetaManagedAgentsFileImageSource object { file_id, type }`

3095 minLength: 1

3096

3097 - `BetaManagedAgentsFileImageSource object`

32253098

32263099 Image referenced by file ID.

32273100

from line 3102

32293102

32303103 ID of a previously uploaded file.

32313104

3105 minLength: 1

3106

32323107 - `type: "file"`

32333108

3234 - `"file"`

3235

32363109 - `type: "image"`

32373110

3238 - `"image"`

3239

3240 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

3111 - `BetaManagedAgentsDocumentBlock object`

32413112

32423113 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

32433114

from line 3116

32453116

32463117 Union type for document source variants.

32473118

3248 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

3119 - `BetaManagedAgentsBase64DocumentSource object`

32493120

32503121 Base64-encoded document data.

32513122

from line 3124

32533124

32543125 Base64-encoded document data.

32553126

3127 minLength: 1

3128

32563129 - `media_type: string`

32573130

32583131 MIME type of the document (e.g., "application/pdf").

32593132

3133 minLength: 1

3134

32603135 - `type: "base64"`

32613136

3262 - `"base64"`

3263

3264 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

3137 - `BetaManagedAgentsPlainTextDocumentSource object`

32653138

32663139 Plain text document content.

32673140

from line 3142

32693142

32703143 The plain text content.

32713144

3145 minLength: 1

3146

32723147 - `media_type: "text/plain"`

32733148

32743149 MIME type of the text content. Must be "text/plain".

32753150

3276 - `"text/plain"`

3277

32783151 - `type: "text"`

32793152

3280 - `"text"`

3281

3282 - `BetaManagedAgentsURLDocumentSource object { type, url }`

3153 - `BetaManagedAgentsURLDocumentSource object`

32833154

32843155 Document referenced by URL.

32853156

32863157 - `type: "url"`

32873158

3288 - `"url"`

3289

32903159 - `url: string`

32913160

32923161 URL of the document to fetch.

32933162

3294 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

3163 minLength: 1

3164

3165 - `BetaManagedAgentsFileDocumentSource object`

32953166

32963167 Document referenced by file ID.

32973168

from line 3170

32993170

33003171 ID of a previously uploaded file.

33013172

3173 minLength: 1

3174

33023175 - `type: "file"`

33033176

3304 - `"file"`

3305

33063177 - `type: "document"`

33073178

3308 - `"document"`

3309

33103179 - `context: optional string or null`

33113180

33123181 Additional context about the document for the model.

from line 3184

33153184

33163185 The title of the document.

33173186

3318 - `BetaManagedAgentsRedactedBlock object { type }`

3187 - `BetaManagedAgentsRedactedBlock object`

33193188

33203189 Placeholder for content withheld by Anthropic model policy.

33213190

33223191 - `type: "redacted"`

33233192

3324 - `"redacted"`

3325

33263193 - `type: "user.message"`

33273194

3328 - `"user.message"`

3329

3330 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

3195 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

33313196

33323197 An outcome the agent should work toward. The agent begins work on receipt.

33333198

from line 3204

33393204

33403205 Rubric for grading the quality of an outcome.

33413206

3342 - `BetaManagedAgentsFileRubric object { file_id, type }`

3207 - `BetaManagedAgentsFileRubric object`

33433208

33443209 Rubric referenced by a file uploaded via the Files API.

33453210

from line 3214

33493214

33503215 - `type: "file"`

33513216

3352 - `"file"`

3353

3354 - `BetaManagedAgentsTextRubric object { content, type }`

3217 - `BetaManagedAgentsTextRubric object`

33553218

33563219 Rubric content provided inline as text.

33573220

from line 3224

33613224

33623225 - `type: "text"`

33633226

3364 - `"text"`

3365

33663227 - `type: "user.define_outcome"`

33673228

3368 - `"user.define_outcome"`

3369

33703229 - `max_iterations: optional number or null`

33713230

33723231 Eval→revision cycles before giving up. Default 3, max 20.

33733232

3374 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

3233 format: int32

3234

3235 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

33753236

33763237 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.

33773238

from line 3244

33833244

33843245 The text content.

33853246

3247 minLength: 1

3248

33863249 - `type: "text"`

33873250

3388 - `"text"`

3389

33903251 - `type: "system.message"`

33913252

3392 - `"system.message"`

3393

33943253 - `metadata: map[string]`

33953254

33963255 Arbitrary key-value metadata. Maximum 16 pairs.

from line 3262

34033262

34043263 Why a deployment is paused. Non-null exactly when `status` is `paused`.

34053264

3406 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

3265 - `BetaManagedAgentsManualDeploymentPausedReason object`

34073266

34083267 The caller invoked the pause endpoint on the deployment.

34093268

34103269 - `type: "manual"`

34113270

3412 - `"manual"`

3413

3414 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

3271 - `BetaManagedAgentsErrorDeploymentPausedReason object`

34153272

34163273 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

34173274

from line 3276

34193276

34203277 The error that triggered an auto-pause. Matches the failed run's `error.type`.

34213278

3422 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

3279 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

34233280

34243281 The deployment's environment was archived.

34253282

34263283 - `type: "environment_archived_error"`

34273284

3428 - `"environment_archived_error"`

3429

3430 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

3285 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

34313286

34323287 The deployment's agent was archived.

34333288

34343289 - `type: "agent_archived_error"`

34353290

3436 - `"agent_archived_error"`

3437

3438 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

3291 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

34393292

34403293 The deployment's environment no longer exists.

34413294

34423295 - `type: "environment_not_found_error"`

34433296

3444 - `"environment_not_found_error"`

3445

3446 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

3297 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

34473298

34483299 A vault referenced by the deployment no longer exists.

34493300

34503301 - `type: "vault_not_found_error"`

34513302

3452 - `"vault_not_found_error"`

3453

3454 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

3303 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

34553304

34563305 A file resource referenced by the deployment no longer exists.

34573306

34583307 - `type: "file_not_found_error"`

34593308

3460 - `"file_not_found_error"`

3461

3462 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

3309 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

34633310

34643311 A referenced resource no longer exists and its kind was not reported.

34653312

34663313 - `type: "session_resource_not_found_error"`

34673314

3468 - `"session_resource_not_found_error"`

3469

3470 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

3315 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

34713316

34723317 The deployment's workspace was archived.

34733318

34743319 - `type: "workspace_archived_error"`

34753320

3476 - `"workspace_archived_error"`

3477

3478 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

3321 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

34793322

34803323 The deployment's organization is disabled.

34813324

34823325 - `type: "organization_disabled_error"`

34833326

3484 - `"organization_disabled_error"`

3485

3486 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

3327 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

34873328

34883329 A memory store referenced by the deployment is archived.

34893330

34903331 - `type: "memory_store_archived_error"`

34913332

3492 - `"memory_store_archived_error"`

3493

3494 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

3333 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

34953334

34963335 A skill referenced by the deployment's agent no longer exists.

34973336

34983337 - `type: "skill_not_found_error"`

34993338

3500 - `"skill_not_found_error"`

3501

3502 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

3339 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

35033340

35043341 A vault referenced by the deployment is archived.

35053342

35063343 - `type: "vault_archived_error"`

35073344

3508 - `"vault_archived_error"`

3509

3510 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

3345 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

35113346

35123347 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

35133348

35143349 - `type: "unknown_error"`

35153350

3516 - `"unknown_error"`

3517

3518 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

3351 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

35193352

35203353 The deployment configures resources, but its environment is self-hosted and cannot mount them.

35213354

35223355 - `type: "self_hosted_resources_unsupported_error"`

35233356

3524 - `"self_hosted_resources_unsupported_error"`

3525

3526 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

3357 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

35273358

35283359 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

35293360

35303361 - `type: "mcp_egress_blocked_error"`

35313362

3532 - `"mcp_egress_blocked_error"`

3533

35343363 - `type: "error"`

35353364

3536 - `"error"`

3537

35383365 - `resources: array of BetaManagedAgentsSessionResourceConfig`

35393366

35403367 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

35413368

3542 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

3369 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

35433370

35443371 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

35453372

35463373 - `type: "github_repository"`

35473374

3548 - `"github_repository"`

3549

35503375 - `url: string`

35513376

35523377 Github URL of the repository

from line 3380

35553380

35563381 Branch or commit to check out. Defaults to the repository's default branch.

35573382

3558 - `BetaManagedAgentsBranchCheckout object { name, type }`

3383 - `BetaManagedAgentsBranchCheckout object`

35593384

35603385 - `name: string`

35613386

35623387 Branch name to check out.

35633388

3389 minLength: 1, maxLength: 255

3390

35643391 - `type: "branch"`

35653392

3566 - `"branch"`

3567

3568 - `BetaManagedAgentsCommitCheckout object { sha, type }`

3393 - `BetaManagedAgentsCommitCheckout object`

35693394

35703395 - `sha: string`

35713396

35723397 Full commit SHA to check out.

35733398

3399 minLength: 7, maxLength: 64

3400

35743401 - `type: "commit"`

35753402

3576 - `"commit"`

3577

35783403 - `mount_path: optional string or null`

35793404

35803405 Mount path in the container. Defaults to `/workspace/<repo-name>`.

35813406

3582 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

3407 - `BetaManagedAgentsFileResourceConfig object`

35833408

35843409 A file mounted into each session's container.

35853410

from line 3414

35893414

35903415 - `type: "file"`

35913416

3592 - `"file"`

3593

35943417 - `mount_path: optional string or null`

35953418

35963419 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

35973420

3598 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

3421 - `BetaManagedAgentsMemoryStoreResourceConfig object`

35993422

36003423 A memory store attached to each session created from this deployment.

36013424

from line 3428

36053428

36063429 - `type: "memory_store"`

36073430

3608 - `"memory_store"`

3609

36103431 - `access: optional "read_write" or "read_only" or null`

36113432

36123433 Access mode for an attached memory store.

from line 3448

36273448

36283449 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).

36293450

3451 minLength: 1, maxLength: 256

3452

36303453 - `timezone: string`

36313454

36323455 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

36333456

3457 minLength: 1

3458

36343459 - `type: "cron"`

36353460

3636 - `"cron"`

3637

36383461 - `last_run_at: optional string or null`

36393462

36403463 A timestamp in RFC 3339 format

36413464

3465 format: date-time

3466

36423467 - `upcoming_runs_at: optional array of string`

36433468

36443469 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 3478

36533478

36543479 - `type: "deployment"`

36553480

3656 - `"deployment"`

3657

36583481 - `updated_at: string`

36593482

36603483 A timestamp in RFC 3339 format

36613484

3485 format: date-time

3486

36623487 - `vault_ids: array of string`

36633488

36643489 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 3504

36793504

36803505 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.

36813506

3682 - `"USD"`

3683

36843507 - `type: "limit"`

36853508

3686 - `"limit"`

3687

36883509### Example

36893510

3690```http

3511```bash

36913512curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \

36923513 -H 'Content-Type: application/json' \

36933514 -H 'anthropic-version: 2023-06-01' \

from line 3517

36963517 -d '{}'

36973518```

36983519

3699#### Response

3520#### Response (200)

37003521

37013522```json

37023523{

from line 3586

37653586

37663587## Archive Deployment

37673588

3768**post** `/v1/deployments/{deployment_id}/archive`

3589**POST** `/v1/deployments/{deployment_id}/archive`

37693590

37703591Archive Deployment

37713592

3772### Path Parameters

3593### Path parameters

37733594

37743595- `deployment_id: string`

37753596

3776### Header Parameters

3597### Headers

37773598

37783599- `"anthropic-beta": optional array of AnthropicBeta`

37793600

from line 3674

38533674

38543675### Returns

38553676

3856- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

3677- `BetaManagedAgentsDeployment object`

38573678

38583679 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.

38593680

from line 3690

38693690

38703691 - `type: "agent"`

38713692

3872 - `"agent"`

3873

38743693 - `version: number`

38753694

3695 format: int32

3696

38763697 - `archived_at: string or null`

38773698

38783699 A timestamp in RFC 3339 format

38793700

3701 format: date-time

3702

38803703 - `created_at: string`

38813704

38823705 A timestamp in RFC 3339 format

38833706

3707 format: date-time

3708

38843709 - `description: string or null`

38853710

38863711 Description of what the deployment does.

from line 3718

38933718

38943719 Events sent to each session immediately after creation.

38953720

3896 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

3721 - `BetaManagedAgentsDeploymentUserMessageEvent object`

38973722

38983723 A user message sent to the session.

38993724

from line 3726

39013726

39023727 Array of content blocks for the user message.

39033728

3904 - `BetaManagedAgentsTextBlock object { text, type }`

3729 - `BetaManagedAgentsTextBlock object`

39053730

39063731 Regular text content.

39073732

from line 3734

39093734

39103735 The text content.

39113736

3737 minLength: 1

3738

39123739 - `type: "text"`

39133740

3914 - `"text"`

3915

3916 - `BetaManagedAgentsImageBlock object { source, type }`

3741 - `BetaManagedAgentsImageBlock object`

39173742

39183743 Image content specified directly as base64 data or as a reference via a URL.

39193744

from line 3746

39213746

39223747 Union type for image source variants.

39233748

3924 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

3749 - `BetaManagedAgentsBase64ImageSource object`

39253750

39263751 Base64-encoded image data.

39273752

from line 3754

39293754

39303755 Base64-encoded image data.

39313756

3757 minLength: 1

3758

39323759 - `media_type: string`

39333760

39343761 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

39353762

3763 minLength: 1

3764

39363765 - `type: "base64"`

39373766

3938 - `"base64"`

3939

3940 - `BetaManagedAgentsURLImageSource object { type, url }`

3767 - `BetaManagedAgentsURLImageSource object`

39413768

39423769 Image referenced by URL.

39433770

39443771 - `type: "url"`

39453772

3946 - `"url"`

3947

39483773 - `url: string`

39493774

39503775 URL of the image to fetch.

39513776

3952 - `BetaManagedAgentsFileImageSource object { file_id, type }`

3777 minLength: 1

3778

3779 - `BetaManagedAgentsFileImageSource object`

39533780

39543781 Image referenced by file ID.

39553782

from line 3784

39573784

39583785 ID of a previously uploaded file.

39593786

3787 minLength: 1

3788

39603789 - `type: "file"`

39613790

3962 - `"file"`

3963

39643791 - `type: "image"`

39653792

3966 - `"image"`

3967

3968 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

3793 - `BetaManagedAgentsDocumentBlock object`

39693794

39703795 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

39713796

from line 3798

39733798

39743799 Union type for document source variants.

39753800

3976 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

3801 - `BetaManagedAgentsBase64DocumentSource object`

39773802

39783803 Base64-encoded document data.

39793804

from line 3806

39813806

39823807 Base64-encoded document data.

39833808

3809 minLength: 1

3810

39843811 - `media_type: string`

39853812

39863813 MIME type of the document (e.g., "application/pdf").

39873814

3815 minLength: 1

3816

39883817 - `type: "base64"`

39893818

3990 - `"base64"`

3991

3992 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

3819 - `BetaManagedAgentsPlainTextDocumentSource object`

39933820

39943821 Plain text document content.

39953822

from line 3824

39973824

39983825 The plain text content.

39993826

3827 minLength: 1

3828

40003829 - `media_type: "text/plain"`

40013830

40023831 MIME type of the text content. Must be "text/plain".

40033832

4004 - `"text/plain"`

4005

40063833 - `type: "text"`

40073834

4008 - `"text"`

4009

4010 - `BetaManagedAgentsURLDocumentSource object { type, url }`

3835 - `BetaManagedAgentsURLDocumentSource object`

40113836

40123837 Document referenced by URL.

40133838

40143839 - `type: "url"`

40153840

4016 - `"url"`

4017

40183841 - `url: string`

40193842

40203843 URL of the document to fetch.

40213844

4022 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

3845 minLength: 1

3846

3847 - `BetaManagedAgentsFileDocumentSource object`

40233848

40243849 Document referenced by file ID.

40253850

from line 3852

40273852

40283853 ID of a previously uploaded file.

40293854

3855 minLength: 1

3856

40303857 - `type: "file"`

40313858

4032 - `"file"`

4033

40343859 - `type: "document"`

40353860

4036 - `"document"`

4037

40383861 - `context: optional string or null`

40393862

40403863 Additional context about the document for the model.

from line 3866

40433866

40443867 The title of the document.

40453868

4046 - `BetaManagedAgentsRedactedBlock object { type }`

3869 - `BetaManagedAgentsRedactedBlock object`

40473870

40483871 Placeholder for content withheld by Anthropic model policy.

40493872

40503873 - `type: "redacted"`

40513874

4052 - `"redacted"`

4053

40543875 - `type: "user.message"`

40553876

4056 - `"user.message"`

4057

4058 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

3877 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

40593878

40603879 An outcome the agent should work toward. The agent begins work on receipt.

40613880

from line 3886

40673886

40683887 Rubric for grading the quality of an outcome.

40693888

4070 - `BetaManagedAgentsFileRubric object { file_id, type }`

3889 - `BetaManagedAgentsFileRubric object`

40713890

40723891 Rubric referenced by a file uploaded via the Files API.

40733892

from line 3896

40773896

40783897 - `type: "file"`

40793898

4080 - `"file"`

4081

4082 - `BetaManagedAgentsTextRubric object { content, type }`

3899 - `BetaManagedAgentsTextRubric object`

40833900

40843901 Rubric content provided inline as text.

40853902

from line 3906

40893906

40903907 - `type: "text"`

40913908

4092 - `"text"`

4093

40943909 - `type: "user.define_outcome"`

40953910

4096 - `"user.define_outcome"`

4097

40983911 - `max_iterations: optional number or null`

40993912

41003913 Eval→revision cycles before giving up. Default 3, max 20.

41013914

4102 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

3915 format: int32

3916

3917 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

41033918

41043919 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.

41053920

from line 3926

41113926

41123927 The text content.

41133928

3929 minLength: 1

3930

41143931 - `type: "text"`

41153932

4116 - `"text"`

4117

41183933 - `type: "system.message"`

41193934

4120 - `"system.message"`

4121

41223935 - `metadata: map[string]`

41233936

41243937 Arbitrary key-value metadata. Maximum 16 pairs.

from line 3944

41313944

41323945 Why a deployment is paused. Non-null exactly when `status` is `paused`.

41333946

4134 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

3947 - `BetaManagedAgentsManualDeploymentPausedReason object`

41353948

41363949 The caller invoked the pause endpoint on the deployment.

41373950

41383951 - `type: "manual"`

41393952

4140 - `"manual"`

4141

4142 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

3953 - `BetaManagedAgentsErrorDeploymentPausedReason object`

41433954

41443955 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

41453956

from line 3958

41473958

41483959 The error that triggered an auto-pause. Matches the failed run's `error.type`.

41493960

4150 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

3961 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

41513962

41523963 The deployment's environment was archived.

41533964

41543965 - `type: "environment_archived_error"`

41553966

4156 - `"environment_archived_error"`

4157

4158 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

3967 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

41593968

41603969 The deployment's agent was archived.

41613970

41623971 - `type: "agent_archived_error"`

41633972

4164 - `"agent_archived_error"`

4165

4166 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

3973 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

41673974

41683975 The deployment's environment no longer exists.

41693976

41703977 - `type: "environment_not_found_error"`

41713978

4172 - `"environment_not_found_error"`

4173

4174 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

3979 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

41753980

41763981 A vault referenced by the deployment no longer exists.

41773982

41783983 - `type: "vault_not_found_error"`

41793984

4180 - `"vault_not_found_error"`

4181

4182 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

3985 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

41833986

41843987 A file resource referenced by the deployment no longer exists.

41853988

41863989 - `type: "file_not_found_error"`

41873990

4188 - `"file_not_found_error"`

4189

4190 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

3991 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

41913992

41923993 A referenced resource no longer exists and its kind was not reported.

41933994

41943995 - `type: "session_resource_not_found_error"`

41953996

4196 - `"session_resource_not_found_error"`

4197

4198 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

3997 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

41993998

42003999 The deployment's workspace was archived.

42014000

42024001 - `type: "workspace_archived_error"`

42034002

4204 - `"workspace_archived_error"`

4205

4206 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

4003 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

42074004

42084005 The deployment's organization is disabled.

42094006

42104007 - `type: "organization_disabled_error"`

42114008

4212 - `"organization_disabled_error"`

4213

4214 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

4009 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

42154010

42164011 A memory store referenced by the deployment is archived.

42174012

42184013 - `type: "memory_store_archived_error"`

42194014

4220 - `"memory_store_archived_error"`

4221

4222 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

4015 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

42234016

42244017 A skill referenced by the deployment's agent no longer exists.

42254018

42264019 - `type: "skill_not_found_error"`

42274020

4228 - `"skill_not_found_error"`

4229

4230 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

4021 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

42314022

42324023 A vault referenced by the deployment is archived.

42334024

42344025 - `type: "vault_archived_error"`

42354026

4236 - `"vault_archived_error"`

4237

4238 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

4027 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

42394028

42404029 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

42414030

42424031 - `type: "unknown_error"`

42434032

4244 - `"unknown_error"`

4245

4246 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

4033 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

42474034

42484035 The deployment configures resources, but its environment is self-hosted and cannot mount them.

42494036

42504037 - `type: "self_hosted_resources_unsupported_error"`

42514038

4252 - `"self_hosted_resources_unsupported_error"`

4253

4254 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

4039 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

42554040

42564041 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

42574042

42584043 - `type: "mcp_egress_blocked_error"`

42594044

4260 - `"mcp_egress_blocked_error"`

4261

42624045 - `type: "error"`

42634046

4264 - `"error"`

4265

42664047 - `resources: array of BetaManagedAgentsSessionResourceConfig`

42674048

42684049 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

42694050

4270 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

4051 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

42714052

42724053 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

42734054

42744055 - `type: "github_repository"`

42754056

4276 - `"github_repository"`

4277

42784057 - `url: string`

42794058

42804059 Github URL of the repository

from line 4062

42834062

42844063 Branch or commit to check out. Defaults to the repository's default branch.

42854064

4286 - `BetaManagedAgentsBranchCheckout object { name, type }`

4065 - `BetaManagedAgentsBranchCheckout object`

42874066

42884067 - `name: string`

42894068

42904069 Branch name to check out.

42914070

4071 minLength: 1, maxLength: 255

4072

42924073 - `type: "branch"`

42934074

4294 - `"branch"`

4295

4296 - `BetaManagedAgentsCommitCheckout object { sha, type }`

4075 - `BetaManagedAgentsCommitCheckout object`

42974076

42984077 - `sha: string`

42994078

43004079 Full commit SHA to check out.

43014080

4081 minLength: 7, maxLength: 64

4082

43024083 - `type: "commit"`

43034084

4304 - `"commit"`

4305

43064085 - `mount_path: optional string or null`

43074086

43084087 Mount path in the container. Defaults to `/workspace/<repo-name>`.

43094088

4310 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

4089 - `BetaManagedAgentsFileResourceConfig object`

43114090

43124091 A file mounted into each session's container.

43134092

from line 4096

43174096

43184097 - `type: "file"`

43194098

4320 - `"file"`

4321

43224099 - `mount_path: optional string or null`

43234100

43244101 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

43254102

4326 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

4103 - `BetaManagedAgentsMemoryStoreResourceConfig object`

43274104

43284105 A memory store attached to each session created from this deployment.

43294106

from line 4110

43334110

43344111 - `type: "memory_store"`

43354112

4336 - `"memory_store"`

4337

43384113 - `access: optional "read_write" or "read_only" or null`

43394114

43404115 Access mode for an attached memory store.

from line 4130

43554130

43564131 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).

43574132

4133 minLength: 1, maxLength: 256

4134

43584135 - `timezone: string`

43594136

43604137 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

43614138

4139 minLength: 1

4140

43624141 - `type: "cron"`

43634142

4364 - `"cron"`

4365

43664143 - `last_run_at: optional string or null`

43674144

43684145 A timestamp in RFC 3339 format

43694146

4147 format: date-time

4148

43704149 - `upcoming_runs_at: optional array of string`

43714150

43724151 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 4160

43814160

43824161 - `type: "deployment"`

43834162

4384 - `"deployment"`

4385

43864163 - `updated_at: string`

43874164

43884165 A timestamp in RFC 3339 format

43894166

4167 format: date-time

4168

43904169 - `vault_ids: array of string`

43914170

43924171 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 4186

44074186

44084187 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.

44094188

4410 - `"USD"`

4411

44124189 - `type: "limit"`

44134190

4414 - `"limit"`

4415

44164191### Example

44174192

4418```http

4193```bash

44194194curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/archive \

44204195 -X POST \

44214196 -H 'anthropic-version: 2023-06-01' \

from line 4198

44234198 -H "X-Api-Key: $ANTHROPIC_API_KEY"

44244199```

44254200

4426#### Response

4201#### Response (200)

44274202

44284203```json

44294204{

from line 4267

44924267

44934268## Run Deployment Now

44944269

4495**post** `/v1/deployments/{deployment_id}/run`

4270**POST** `/v1/deployments/{deployment_id}/run`

44964271

44974272Run Deployment Now

44984273

4499### Path Parameters

4274### Path parameters

45004275

45014276- `deployment_id: string`

45024277

4503### Header Parameters

4278### Headers

45044279

45054280- `"anthropic-beta": optional array of AnthropicBeta`

45064281

from line 4355

45804355

45814356### Returns

45824357

4583- `BetaManagedAgentsDeploymentRun object { id, agent, created_at, 5 more }`

4358- `BetaManagedAgentsDeploymentRun object`

45844359

45854360 A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.

45864361

from line 4371

45964371

45974372 - `type: "agent"`

45984373

4599 - `"agent"`

4600

46014374 - `version: number`

46024375

4376 format: int32

4377

46034378 - `created_at: string`

46044379

46054380 A timestamp in RFC 3339 format

46064381

4382 format: date-time

4383

46074384 - `deployment_id: string`

46084385

46094386 ID of the deployment that produced this run.

from line 4389

46124389

46134390 Why the run failed to create a session. The type identifies the failure; message is human-readable detail.

46144391

4615 - `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }`

4392 - `BetaManagedAgentsEnvironmentArchivedRunError object`

46164393

46174394 The deployment's environment was archived.

46184395

from line 4399

46224399

46234400 - `type: "environment_archived_error"`

46244401

4625 - `"environment_archived_error"`

4626

4627 - `BetaManagedAgentsAgentArchivedRunError object { message, type }`

4402 - `BetaManagedAgentsAgentArchivedRunError object`

46284403

46294404 The deployment's agent was archived.

46304405

from line 4409

46344409

46354410 - `type: "agent_archived_error"`

46364411

4637 - `"agent_archived_error"`

4638

4639 - `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }`

4412 - `BetaManagedAgentsEnvironmentNotFoundRunError object`

46404413

46414414 The deployment's environment no longer exists.

46424415

from line 4419

46464419

46474420 - `type: "environment_not_found_error"`

46484421

4649 - `"environment_not_found_error"`

4650

4651 - `BetaManagedAgentsVaultNotFoundRunError object { message, type }`

4422 - `BetaManagedAgentsVaultNotFoundRunError object`

46524423

46534424 A vault referenced by the deployment no longer exists.

46544425

from line 4429

46584429

46594430 - `type: "vault_not_found_error"`

46604431

4661 - `"vault_not_found_error"`

4662

4663 - `BetaManagedAgentsVaultArchivedRunError object { message, type }`

4432 - `BetaManagedAgentsVaultArchivedRunError object`

46644433

46654434 A vault referenced by the deployment is archived.

46664435

from line 4439

46704439

46714440 - `type: "vault_archived_error"`

46724441

4673 - `"vault_archived_error"`

4674

4675 - `BetaManagedAgentsFileNotFoundRunError object { message, type }`

4442 - `BetaManagedAgentsFileNotFoundRunError object`

46764443

46774444 A file resource referenced by the deployment no longer exists.

46784445

from line 4449

46824449

46834450 - `type: "file_not_found_error"`

46844451

4685 - `"file_not_found_error"`

4686

4687 - `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }`

4452 - `BetaManagedAgentsMemoryStoreArchivedRunError object`

46884453

46894454 A memory store referenced by the deployment is archived.

46904455

from line 4459

46944459

46954460 - `type: "memory_store_archived_error"`

46964461

4697 - `"memory_store_archived_error"`

4698

4699 - `BetaManagedAgentsSkillNotFoundRunError object { message, type }`

4462 - `BetaManagedAgentsSkillNotFoundRunError object`

47004463

47014464 A skill referenced by the deployment's agent no longer exists.

47024465

from line 4469

47064469

47074470 - `type: "skill_not_found_error"`

47084471

4709 - `"skill_not_found_error"`

4710

4711 - `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }`

4472 - `BetaManagedAgentsSessionResourceNotFoundRunError object`

47124473

47134474 A referenced resource no longer exists and its kind was not reported.

47144475

from line 4479

47184479

47194480 - `type: "session_resource_not_found_error"`

47204481

4721 - `"session_resource_not_found_error"`

4722

4723 - `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }`

4482 - `BetaManagedAgentsWorkspaceArchivedRunError object`

47244483

47254484 The deployment's workspace was archived.

47264485

from line 4489

47304489

47314490 - `type: "workspace_archived_error"`

47324491

4733 - `"workspace_archived_error"`

4734

4735 - `BetaManagedAgentsOrganizationDisabledRunError object { message, type }`

4492 - `BetaManagedAgentsOrganizationDisabledRunError object`

47364493

47374494 The deployment's organization is disabled.

47384495

from line 4499

47424499

47434500 - `type: "organization_disabled_error"`

47444501

4745 - `"organization_disabled_error"`

4746

4747 - `BetaManagedAgentsSessionRateLimitedRunError object { message, type }`

4502 - `BetaManagedAgentsSessionRateLimitedRunError object`

47484503

47494504 Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.

47504505

from line 4509

47544509

47554510 - `type: "session_rate_limited_error"`

47564511

4757 - `"session_rate_limited_error"`

4758

4759 - `BetaManagedAgentsSessionCreationRejectedRunError object { message, type }`

4512 - `BetaManagedAgentsSessionCreationRejectedRunError object`

47604513

47614514 The session create request was rejected with a non-retryable validation error.

47624515

from line 4519

47664519

47674520 - `type: "session_creation_rejected_error"`

47684521

4769 - `"session_creation_rejected_error"`

4770

4771 - `BetaManagedAgentsUnknownRunError object { message, type }`

4522 - `BetaManagedAgentsUnknownRunError object`

47724523

47734524 An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone.

47744525

from line 4529

47784529

47794530 - `type: "unknown_error"`

47804531

4781 - `"unknown_error"`

4782

4783 - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object { message, type }`

4532 - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object`

47844533

47854534 The deployment configures resources, but its environment is self-hosted and cannot mount them.

47864535

from line 4539

47904539

47914540 - `type: "self_hosted_resources_unsupported_error"`

47924541

4793 - `"self_hosted_resources_unsupported_error"`

4794

4795 - `BetaManagedAgentsMCPEgressBlockedRunError object { message, type }`

4542 - `BetaManagedAgentsMCPEgressBlockedRunError object`

47964543

47974544 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

47984545

from line 4549

48024549

48034550 - `type: "mcp_egress_blocked_error"`

48044551

4805 - `"mcp_egress_blocked_error"`

4806

48074552 - `session_id: string or null`

48084553

48094554 Populated on success. Null on creation failure. Exactly one of session_id or error is non-null.

from line 4557

48124557

48134558 Describes what triggered a deployment run, with trigger-specific metadata.

48144559

4815 - `BetaManagedAgentsScheduleTriggerContext object { scheduled_at, type }`

4560 - `BetaManagedAgentsScheduleTriggerContext object`

48164561

48174562 The run was fired by the deployment's cron schedule.

48184563

from line 4565

48204565

48214566 A timestamp in RFC 3339 format

48224567

4568 format: date-time

4569

48234570 - `type: "schedule"`

48244571

4825 - `"schedule"`

4826

4827 - `BetaManagedAgentsManualTriggerContext object { type }`

4572 - `BetaManagedAgentsManualTriggerContext object`

48284573

48294574 The run was started manually by creating a session directly against the deployment.

48304575

48314576 - `type: "manual"`

48324577

4833 - `"manual"`

4834

48354578 - `type: "deployment_run"`

48364579

4837 - `"deployment_run"`

4838

48394580### Example

48404581

4841```http

4582```bash

48424583curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/run \

48434584 -X POST \

48444585 -H 'anthropic-version: 2023-06-01' \

from line 4587

48464587 -H "X-Api-Key: $ANTHROPIC_API_KEY"

48474588```

48484589

4849#### Response

4590#### Response (200)

48504591

48514592```json

48524593{

from line 4614

48734614

48744615## Pause Deployment

48754616

4876**post** `/v1/deployments/{deployment_id}/pause`

4617**POST** `/v1/deployments/{deployment_id}/pause`

48774618

48784619Pause Deployment

48794620

4880### Path Parameters

4621### Path parameters

48814622

48824623- `deployment_id: string`

48834624

4884### Header Parameters

4625### Headers

48854626

48864627- `"anthropic-beta": optional array of AnthropicBeta`

48874628

from line 4702

49614702

49624703### Returns

49634704

4964- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

4705- `BetaManagedAgentsDeployment object`

49654706

49664707 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.

49674708

from line 4718

49774718

49784719 - `type: "agent"`

49794720

4980 - `"agent"`

4981

49824721 - `version: number`

49834722

4723 format: int32

4724

49844725 - `archived_at: string or null`

49854726

49864727 A timestamp in RFC 3339 format

49874728

4729 format: date-time

4730

49884731 - `created_at: string`

49894732

49904733 A timestamp in RFC 3339 format

49914734

4735 format: date-time

4736

49924737 - `description: string or null`

49934738

49944739 Description of what the deployment does.

from line 4746

50014746

50024747 Events sent to each session immediately after creation.

50034748

5004 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

4749 - `BetaManagedAgentsDeploymentUserMessageEvent object`

50054750

50064751 A user message sent to the session.

50074752

from line 4754

50094754

50104755 Array of content blocks for the user message.

50114756

5012 - `BetaManagedAgentsTextBlock object { text, type }`

4757 - `BetaManagedAgentsTextBlock object`

50134758

50144759 Regular text content.

50154760

from line 4762

50174762

50184763 The text content.

50194764

4765 minLength: 1

4766

50204767 - `type: "text"`

50214768

5022 - `"text"`

5023

5024 - `BetaManagedAgentsImageBlock object { source, type }`

4769 - `BetaManagedAgentsImageBlock object`

50254770

50264771 Image content specified directly as base64 data or as a reference via a URL.

50274772

from line 4774

50294774

50304775 Union type for image source variants.

50314776

5032 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

4777 - `BetaManagedAgentsBase64ImageSource object`

50334778

50344779 Base64-encoded image data.

50354780

from line 4782

50374782

50384783 Base64-encoded image data.

50394784

4785 minLength: 1

4786

50404787 - `media_type: string`

50414788

50424789 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

50434790

4791 minLength: 1

4792

50444793 - `type: "base64"`

50454794

5046 - `"base64"`

5047

5048 - `BetaManagedAgentsURLImageSource object { type, url }`

4795 - `BetaManagedAgentsURLImageSource object`

50494796

50504797 Image referenced by URL.

50514798

50524799 - `type: "url"`

50534800

5054 - `"url"`

5055

50564801 - `url: string`

50574802

50584803 URL of the image to fetch.

50594804

5060 - `BetaManagedAgentsFileImageSource object { file_id, type }`

4805 minLength: 1

4806

4807 - `BetaManagedAgentsFileImageSource object`

50614808

50624809 Image referenced by file ID.

50634810

from line 4812

50654812

50664813 ID of a previously uploaded file.

50674814

4815 minLength: 1

4816

50684817 - `type: "file"`

50694818

5070 - `"file"`

5071

50724819 - `type: "image"`

50734820

5074 - `"image"`

5075

5076 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

4821 - `BetaManagedAgentsDocumentBlock object`

50774822

50784823 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

50794824

from line 4826

50814826

50824827 Union type for document source variants.

50834828

5084 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

4829 - `BetaManagedAgentsBase64DocumentSource object`

50854830

50864831 Base64-encoded document data.

50874832

from line 4834

50894834

50904835 Base64-encoded document data.

50914836

4837 minLength: 1

4838

50924839 - `media_type: string`

50934840

50944841 MIME type of the document (e.g., "application/pdf").

50954842

4843 minLength: 1

4844

50964845 - `type: "base64"`

50974846

5098 - `"base64"`

5099

5100 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

4847 - `BetaManagedAgentsPlainTextDocumentSource object`

51014848

51024849 Plain text document content.

51034850

from line 4852

51054852

51064853 The plain text content.

51074854

4855 minLength: 1

4856

51084857 - `media_type: "text/plain"`

51094858

51104859 MIME type of the text content. Must be "text/plain".

51114860

5112 - `"text/plain"`

5113

51144861 - `type: "text"`

51154862

5116 - `"text"`

5117

5118 - `BetaManagedAgentsURLDocumentSource object { type, url }`

4863 - `BetaManagedAgentsURLDocumentSource object`

51194864

51204865 Document referenced by URL.

51214866

51224867 - `type: "url"`

51234868

5124 - `"url"`

5125

51264869 - `url: string`

51274870

51284871 URL of the document to fetch.

51294872

5130 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

4873 minLength: 1

4874

4875 - `BetaManagedAgentsFileDocumentSource object`

51314876

51324877 Document referenced by file ID.

51334878

from line 4880

51354880

51364881 ID of a previously uploaded file.

51374882

4883 minLength: 1

4884

51384885 - `type: "file"`

51394886

5140 - `"file"`

5141

51424887 - `type: "document"`

51434888

5144 - `"document"`

5145

51464889 - `context: optional string or null`

51474890

51484891 Additional context about the document for the model.

from line 4894

51514894

51524895 The title of the document.

51534896

5154 - `BetaManagedAgentsRedactedBlock object { type }`

4897 - `BetaManagedAgentsRedactedBlock object`

51554898

51564899 Placeholder for content withheld by Anthropic model policy.

51574900

51584901 - `type: "redacted"`

51594902

5160 - `"redacted"`

5161

51624903 - `type: "user.message"`

51634904

5164 - `"user.message"`

5165

5166 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

4905 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

51674906

51684907 An outcome the agent should work toward. The agent begins work on receipt.

51694908

from line 4914

51754914

51764915 Rubric for grading the quality of an outcome.

51774916

5178 - `BetaManagedAgentsFileRubric object { file_id, type }`

4917 - `BetaManagedAgentsFileRubric object`

51794918

51804919 Rubric referenced by a file uploaded via the Files API.

51814920

from line 4924

51854924

51864925 - `type: "file"`

51874926

5188 - `"file"`

5189

5190 - `BetaManagedAgentsTextRubric object { content, type }`

4927 - `BetaManagedAgentsTextRubric object`

51914928

51924929 Rubric content provided inline as text.

51934930

from line 4934

51974934

51984935 - `type: "text"`

51994936

5200 - `"text"`

5201

52024937 - `type: "user.define_outcome"`

52034938

5204 - `"user.define_outcome"`

5205

52064939 - `max_iterations: optional number or null`

52074940

52084941 Eval→revision cycles before giving up. Default 3, max 20.

52094942

5210 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

4943 format: int32

4944

4945 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

52114946

52124947 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.

52134948

from line 4954

52194954

52204955 The text content.

52214956

4957 minLength: 1

4958

52224959 - `type: "text"`

52234960

5224 - `"text"`

5225

52264961 - `type: "system.message"`

52274962

5228 - `"system.message"`

5229

52304963 - `metadata: map[string]`

52314964

52324965 Arbitrary key-value metadata. Maximum 16 pairs.

from line 4972

52394972

52404973 Why a deployment is paused. Non-null exactly when `status` is `paused`.

52414974

5242 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

4975 - `BetaManagedAgentsManualDeploymentPausedReason object`

52434976

52444977 The caller invoked the pause endpoint on the deployment.

52454978

52464979 - `type: "manual"`

52474980

5248 - `"manual"`

5249

5250 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

4981 - `BetaManagedAgentsErrorDeploymentPausedReason object`

52514982

52524983 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

52534984

from line 4986

52554986

52564987 The error that triggered an auto-pause. Matches the failed run's `error.type`.

52574988

5258 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

4989 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

52594990

52604991 The deployment's environment was archived.

52614992

52624993 - `type: "environment_archived_error"`

52634994

5264 - `"environment_archived_error"`

5265

5266 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

4995 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

52674996

52684997 The deployment's agent was archived.

52694998

52704999 - `type: "agent_archived_error"`

52715000

5272 - `"agent_archived_error"`

5273

5274 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

5001 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

52755002

52765003 The deployment's environment no longer exists.

52775004

52785005 - `type: "environment_not_found_error"`

52795006

5280 - `"environment_not_found_error"`

5281

5282 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

5007 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

52835008

52845009 A vault referenced by the deployment no longer exists.

52855010

52865011 - `type: "vault_not_found_error"`

52875012

5288 - `"vault_not_found_error"`

5289

5290 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

5013 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

52915014

52925015 A file resource referenced by the deployment no longer exists.

52935016

52945017 - `type: "file_not_found_error"`

52955018

5296 - `"file_not_found_error"`

5297

5298 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

5019 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

52995020

53005021 A referenced resource no longer exists and its kind was not reported.

53015022

53025023 - `type: "session_resource_not_found_error"`

53035024

5304 - `"session_resource_not_found_error"`

5305

5306 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

5025 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

53075026

53085027 The deployment's workspace was archived.

53095028

53105029 - `type: "workspace_archived_error"`

53115030

5312 - `"workspace_archived_error"`

5313

5314 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

5031 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

53155032

53165033 The deployment's organization is disabled.

53175034

53185035 - `type: "organization_disabled_error"`

53195036

5320 - `"organization_disabled_error"`

5321

5322 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

5037 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

53235038

53245039 A memory store referenced by the deployment is archived.

53255040

53265041 - `type: "memory_store_archived_error"`

53275042

5328 - `"memory_store_archived_error"`

5329

5330 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

5043 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

53315044

53325045 A skill referenced by the deployment's agent no longer exists.

53335046

53345047 - `type: "skill_not_found_error"`

53355048

5336 - `"skill_not_found_error"`

5337

5338 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

5049 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

53395050

53405051 A vault referenced by the deployment is archived.

53415052

53425053 - `type: "vault_archived_error"`

53435054

5344 - `"vault_archived_error"`

5345

5346 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

5055 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

53475056

53485057 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

53495058

53505059 - `type: "unknown_error"`

53515060

5352 - `"unknown_error"`

5353

5354 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

5061 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

53555062

53565063 The deployment configures resources, but its environment is self-hosted and cannot mount them.

53575064

53585065 - `type: "self_hosted_resources_unsupported_error"`

53595066

5360 - `"self_hosted_resources_unsupported_error"`

5361

5362 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

5067 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

53635068

53645069 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

53655070

53665071 - `type: "mcp_egress_blocked_error"`

53675072

5368 - `"mcp_egress_blocked_error"`

5369

53705073 - `type: "error"`

53715074

5372 - `"error"`

5373

53745075 - `resources: array of BetaManagedAgentsSessionResourceConfig`

53755076

53765077 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

53775078

5378 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

5079 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

53795080

53805081 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

53815082

53825083 - `type: "github_repository"`

53835084

5384 - `"github_repository"`

5385

53865085 - `url: string`

53875086

53885087 Github URL of the repository

from line 5090

53915090

53925091 Branch or commit to check out. Defaults to the repository's default branch.

53935092

5394 - `BetaManagedAgentsBranchCheckout object { name, type }`

5093 - `BetaManagedAgentsBranchCheckout object`

53955094

53965095 - `name: string`

53975096

53985097 Branch name to check out.

53995098

5099 minLength: 1, maxLength: 255

5100

54005101 - `type: "branch"`

54015102

5402 - `"branch"`

5403

5404 - `BetaManagedAgentsCommitCheckout object { sha, type }`

5103 - `BetaManagedAgentsCommitCheckout object`

54055104

54065105 - `sha: string`

54075106

54085107 Full commit SHA to check out.

54095108

5109 minLength: 7, maxLength: 64

5110

54105111 - `type: "commit"`

54115112

5412 - `"commit"`

5413

54145113 - `mount_path: optional string or null`

54155114

54165115 Mount path in the container. Defaults to `/workspace/<repo-name>`.

54175116

5418 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

5117 - `BetaManagedAgentsFileResourceConfig object`

54195118

54205119 A file mounted into each session's container.

54215120

from line 5124

54255124

54265125 - `type: "file"`

54275126

5428 - `"file"`

5429

54305127 - `mount_path: optional string or null`

54315128

54325129 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

54335130

5434 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

5131 - `BetaManagedAgentsMemoryStoreResourceConfig object`

54355132

54365133 A memory store attached to each session created from this deployment.

54375134

from line 5138

54415138

54425139 - `type: "memory_store"`

54435140

5444 - `"memory_store"`

5445

54465141 - `access: optional "read_write" or "read_only" or null`

54475142

54485143 Access mode for an attached memory store.

from line 5158

54635158

54645159 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).

54655160

5161 minLength: 1, maxLength: 256

5162

54665163 - `timezone: string`

54675164

54685165 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

54695166

5167 minLength: 1

5168

54705169 - `type: "cron"`

54715170

5472 - `"cron"`

5473

54745171 - `last_run_at: optional string or null`

54755172

54765173 A timestamp in RFC 3339 format

54775174

5175 format: date-time

5176

54785177 - `upcoming_runs_at: optional array of string`

54795178

54805179 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 5188

54895188

54905189 - `type: "deployment"`

54915190

5492 - `"deployment"`

5493

54945191 - `updated_at: string`

54955192

54965193 A timestamp in RFC 3339 format

54975194

5195 format: date-time

5196

54985197 - `vault_ids: array of string`

54995198

55005199 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 5214

55155214

55165215 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.

55175216

5518 - `"USD"`

5519

55205217 - `type: "limit"`

55215218

5522 - `"limit"`

5523

55245219### Example

55255220

5526```http

5221```bash

55275222curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/pause \

55285223 -X POST \

55295224 -H 'anthropic-version: 2023-06-01' \

from line 5226

55315226 -H "X-Api-Key: $ANTHROPIC_API_KEY"

55325227```

55335228

5534#### Response

5229#### Response (200)

55355230

55365231```json

55375232{

from line 5295

56005295

56015296## Unpause Deployment

56025297

5603**post** `/v1/deployments/{deployment_id}/unpause`

5298**POST** `/v1/deployments/{deployment_id}/unpause`

56045299

56055300Unpause Deployment

56065301

5607### Path Parameters

5302### Path parameters

56085303

56095304- `deployment_id: string`

56105305

5611### Header Parameters

5306### Headers

56125307

56135308- `"anthropic-beta": optional array of AnthropicBeta`

56145309

from line 5383

56885383

56895384### Returns

56905385

5691- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

5386- `BetaManagedAgentsDeployment object`

56925387

56935388 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.

56945389

from line 5399

57045399

57055400 - `type: "agent"`

57065401

5707 - `"agent"`

5708

57095402 - `version: number`

57105403

5404 format: int32

5405

57115406 - `archived_at: string or null`

57125407

57135408 A timestamp in RFC 3339 format

57145409

5410 format: date-time

5411

57155412 - `created_at: string`

57165413

57175414 A timestamp in RFC 3339 format

57185415

5416 format: date-time

5417

57195418 - `description: string or null`

57205419

57215420 Description of what the deployment does.

from line 5427

57285427

57295428 Events sent to each session immediately after creation.

57305429

5731 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

5430 - `BetaManagedAgentsDeploymentUserMessageEvent object`

57325431

57335432 A user message sent to the session.

57345433

from line 5435

57365435

57375436 Array of content blocks for the user message.

57385437

5739 - `BetaManagedAgentsTextBlock object { text, type }`

5438 - `BetaManagedAgentsTextBlock object`

57405439

57415440 Regular text content.

57425441

from line 5443

57445443

57455444 The text content.

57465445

5446 minLength: 1

5447

57475448 - `type: "text"`

57485449

5749 - `"text"`

5750

5751 - `BetaManagedAgentsImageBlock object { source, type }`

5450 - `BetaManagedAgentsImageBlock object`

57525451

57535452 Image content specified directly as base64 data or as a reference via a URL.

57545453

from line 5455

57565455

57575456 Union type for image source variants.

57585457

5759 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

5458 - `BetaManagedAgentsBase64ImageSource object`

57605459

57615460 Base64-encoded image data.

57625461

from line 5463

57645463

57655464 Base64-encoded image data.

57665465

5466 minLength: 1

5467

57675468 - `media_type: string`

57685469

57695470 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

57705471

5472 minLength: 1

5473

57715474 - `type: "base64"`

57725475

5773 - `"base64"`

5774

5775 - `BetaManagedAgentsURLImageSource object { type, url }`

5476 - `BetaManagedAgentsURLImageSource object`

57765477

57775478 Image referenced by URL.

57785479

57795480 - `type: "url"`

57805481

5781 - `"url"`

5782

57835482 - `url: string`

57845483

57855484 URL of the image to fetch.

57865485

5787 - `BetaManagedAgentsFileImageSource object { file_id, type }`

5486 minLength: 1

5487

5488 - `BetaManagedAgentsFileImageSource object`

57885489

57895490 Image referenced by file ID.

57905491

from line 5493

57925493

57935494 ID of a previously uploaded file.

57945495

5496 minLength: 1

5497

57955498 - `type: "file"`

57965499

5797 - `"file"`

5798

57995500 - `type: "image"`

58005501

5801 - `"image"`

5802

5803 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

5502 - `BetaManagedAgentsDocumentBlock object`

58045503

58055504 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

58065505

from line 5507

58085507

58095508 Union type for document source variants.

58105509

5811 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

5510 - `BetaManagedAgentsBase64DocumentSource object`

58125511

58135512 Base64-encoded document data.

58145513

from line 5515

58165515

58175516 Base64-encoded document data.

58185517

5518 minLength: 1

5519

58195520 - `media_type: string`

58205521

58215522 MIME type of the document (e.g., "application/pdf").

58225523

5524 minLength: 1

5525

58235526 - `type: "base64"`

58245527

5825 - `"base64"`

5826

5827 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

5528 - `BetaManagedAgentsPlainTextDocumentSource object`

58285529

58295530 Plain text document content.

58305531

from line 5533

58325533

58335534 The plain text content.

58345535

5536 minLength: 1

5537

58355538 - `media_type: "text/plain"`

58365539

58375540 MIME type of the text content. Must be "text/plain".

58385541

5839 - `"text/plain"`

5840

58415542 - `type: "text"`

58425543

5843 - `"text"`

5844

5845 - `BetaManagedAgentsURLDocumentSource object { type, url }`

5544 - `BetaManagedAgentsURLDocumentSource object`

58465545

58475546 Document referenced by URL.

58485547

58495548 - `type: "url"`

58505549

5851 - `"url"`

5852

58535550 - `url: string`

58545551

58555552 URL of the document to fetch.

58565553

5857 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

5554 minLength: 1

5555

5556 - `BetaManagedAgentsFileDocumentSource object`

58585557

58595558 Document referenced by file ID.

58605559

from line 5561

58625561

58635562 ID of a previously uploaded file.

58645563

5564 minLength: 1

5565

58655566 - `type: "file"`

58665567

5867 - `"file"`

5868

58695568 - `type: "document"`

58705569

5871 - `"document"`

5872

58735570 - `context: optional string or null`

58745571

58755572 Additional context about the document for the model.

from line 5575

58785575

58795576 The title of the document.

58805577

5881 - `BetaManagedAgentsRedactedBlock object { type }`

5578 - `BetaManagedAgentsRedactedBlock object`

58825579

58835580 Placeholder for content withheld by Anthropic model policy.

58845581

58855582 - `type: "redacted"`

58865583

5887 - `"redacted"`

5888

58895584 - `type: "user.message"`

58905585

5891 - `"user.message"`

5892

5893 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

5586 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

58945587

58955588 An outcome the agent should work toward. The agent begins work on receipt.

58965589

from line 5595

59025595

59035596 Rubric for grading the quality of an outcome.

59045597

5905 - `BetaManagedAgentsFileRubric object { file_id, type }`

5598 - `BetaManagedAgentsFileRubric object`

59065599

59075600 Rubric referenced by a file uploaded via the Files API.

59085601

from line 5605

59125605

59135606 - `type: "file"`

59145607

5915 - `"file"`

5916

5917 - `BetaManagedAgentsTextRubric object { content, type }`

5608 - `BetaManagedAgentsTextRubric object`

59185609

59195610 Rubric content provided inline as text.

59205611

from line 5615

59245615

59255616 - `type: "text"`

59265617

5927 - `"text"`

5928

59295618 - `type: "user.define_outcome"`

59305619

5931 - `"user.define_outcome"`

5932

59335620 - `max_iterations: optional number or null`

59345621

59355622 Eval→revision cycles before giving up. Default 3, max 20.

59365623

5937 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

5624 format: int32

5625

5626 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

59385627

59395628 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.

59405629

from line 5635

59465635

59475636 The text content.

59485637

5638 minLength: 1

5639

59495640 - `type: "text"`

59505641

5951 - `"text"`

5952

59535642 - `type: "system.message"`

59545643

5955 - `"system.message"`

5956

59575644 - `metadata: map[string]`

59585645

59595646 Arbitrary key-value metadata. Maximum 16 pairs.

from line 5653

59665653

59675654 Why a deployment is paused. Non-null exactly when `status` is `paused`.

59685655

5969 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

5656 - `BetaManagedAgentsManualDeploymentPausedReason object`

59705657

59715658 The caller invoked the pause endpoint on the deployment.

59725659

59735660 - `type: "manual"`

59745661

5975 - `"manual"`

5976

5977 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

5662 - `BetaManagedAgentsErrorDeploymentPausedReason object`

59785663

59795664 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

59805665

from line 5667

59825667

59835668 The error that triggered an auto-pause. Matches the failed run's `error.type`.

59845669

5985 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

5670 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

59865671

59875672 The deployment's environment was archived.

59885673

59895674 - `type: "environment_archived_error"`

59905675

5991 - `"environment_archived_error"`

5992

5993 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

5676 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

59945677

59955678 The deployment's agent was archived.

59965679

59975680 - `type: "agent_archived_error"`

59985681

5999 - `"agent_archived_error"`

6000

6001 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

5682 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

60025683

60035684 The deployment's environment no longer exists.

60045685

60055686 - `type: "environment_not_found_error"`

60065687

6007 - `"environment_not_found_error"`

6008

6009 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

5688 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

60105689

60115690 A vault referenced by the deployment no longer exists.

60125691

60135692 - `type: "vault_not_found_error"`

60145693

6015 - `"vault_not_found_error"`

6016

6017 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

5694 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

60185695

60195696 A file resource referenced by the deployment no longer exists.

60205697

60215698 - `type: "file_not_found_error"`

60225699

6023 - `"file_not_found_error"`

6024

6025 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

5700 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

60265701

60275702 A referenced resource no longer exists and its kind was not reported.

60285703

60295704 - `type: "session_resource_not_found_error"`

60305705

6031 - `"session_resource_not_found_error"`

6032

6033 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

5706 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

60345707

60355708 The deployment's workspace was archived.

60365709

60375710 - `type: "workspace_archived_error"`

60385711

6039 - `"workspace_archived_error"`

6040

6041 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

5712 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

60425713

60435714 The deployment's organization is disabled.

60445715

60455716 - `type: "organization_disabled_error"`

60465717

6047 - `"organization_disabled_error"`

6048

6049 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

5718 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

60505719

60515720 A memory store referenced by the deployment is archived.

60525721

60535722 - `type: "memory_store_archived_error"`

60545723

6055 - `"memory_store_archived_error"`

6056

6057 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

5724 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

60585725

60595726 A skill referenced by the deployment's agent no longer exists.

60605727

60615728 - `type: "skill_not_found_error"`

60625729

6063 - `"skill_not_found_error"`

6064

6065 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

5730 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

60665731

60675732 A vault referenced by the deployment is archived.

60685733

60695734 - `type: "vault_archived_error"`

60705735

6071 - `"vault_archived_error"`

6072

6073 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

5736 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

60745737

60755738 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

60765739

60775740 - `type: "unknown_error"`

60785741

6079 - `"unknown_error"`

6080

6081 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

5742 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

60825743

60835744 The deployment configures resources, but its environment is self-hosted and cannot mount them.

60845745

60855746 - `type: "self_hosted_resources_unsupported_error"`

60865747

6087 - `"self_hosted_resources_unsupported_error"`

6088

6089 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

5748 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

60905749

60915750 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

60925751

60935752 - `type: "mcp_egress_blocked_error"`

60945753

6095 - `"mcp_egress_blocked_error"`

6096

60975754 - `type: "error"`

60985755

6099 - `"error"`

6100

61015756 - `resources: array of BetaManagedAgentsSessionResourceConfig`

61025757

61035758 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

61045759

6105 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

5760 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

61065761

61075762 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

61085763

61095764 - `type: "github_repository"`

61105765

6111 - `"github_repository"`

6112

61135766 - `url: string`

61145767

61155768 Github URL of the repository

from line 5771

61185771

61195772 Branch or commit to check out. Defaults to the repository's default branch.

61205773

6121 - `BetaManagedAgentsBranchCheckout object { name, type }`

5774 - `BetaManagedAgentsBranchCheckout object`

61225775

61235776 - `name: string`

61245777

61255778 Branch name to check out.

61265779

5780 minLength: 1, maxLength: 255

5781

61275782 - `type: "branch"`

61285783

6129 - `"branch"`

6130

6131 - `BetaManagedAgentsCommitCheckout object { sha, type }`

5784 - `BetaManagedAgentsCommitCheckout object`

61325785

61335786 - `sha: string`

61345787

61355788 Full commit SHA to check out.

61365789

5790 minLength: 7, maxLength: 64

5791

61375792 - `type: "commit"`

61385793

6139 - `"commit"`

6140

61415794 - `mount_path: optional string or null`

61425795

61435796 Mount path in the container. Defaults to `/workspace/<repo-name>`.

61445797

6145 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

5798 - `BetaManagedAgentsFileResourceConfig object`

61465799

61475800 A file mounted into each session's container.

61485801

from line 5805

61525805

61535806 - `type: "file"`

61545807

6155 - `"file"`

6156

61575808 - `mount_path: optional string or null`

61585809

61595810 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

61605811

6161 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

5812 - `BetaManagedAgentsMemoryStoreResourceConfig object`

61625813

61635814 A memory store attached to each session created from this deployment.

61645815

from line 5819

61685819

61695820 - `type: "memory_store"`

61705821

6171 - `"memory_store"`

6172

61735822 - `access: optional "read_write" or "read_only" or null`

61745823

61755824 Access mode for an attached memory store.

from line 5839

61905839

61915840 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).

61925841

5842 minLength: 1, maxLength: 256

5843

61935844 - `timezone: string`

61945845

61955846 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

61965847

5848 minLength: 1

5849

61975850 - `type: "cron"`

61985851

6199 - `"cron"`

6200

62015852 - `last_run_at: optional string or null`

62025853

62035854 A timestamp in RFC 3339 format

62045855

5856 format: date-time

5857

62055858 - `upcoming_runs_at: optional array of string`

62065859

62075860 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 5869

62165869

62175870 - `type: "deployment"`

62185871

6219 - `"deployment"`

6220

62215872 - `updated_at: string`

62225873

62235874 A timestamp in RFC 3339 format

62245875

5876 format: date-time

5877

62255878 - `vault_ids: array of string`

62265879

62275880 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 5895

62425895

62435896 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.

62445897

6245 - `"USD"`

6246

62475898 - `type: "limit"`

62485899

6249 - `"limit"`

6250

62515900### Example

62525901

6253```http

5902```bash

62545903curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/unpause \

62555904 -X POST \

62565905 -H 'anthropic-version: 2023-06-01' \

from line 5907

62585907 -H "X-Api-Key: $ANTHROPIC_API_KEY"

62595908```

62605909

6261#### Response

5910#### Response (200)

62625911

62635912```json

62645913{

from line 5974

63255974}

63265975```

63275976

6328## Domain Types

5977## Domain types

63295978

63305979### Beta Managed Agents Agent Archived Deployment Paused Reason Error

63315980

6332- `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

5981- `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

63335982

63345983 The deployment's agent was archived.

63355984

63365985 - `type: "agent_archived_error"`

63375986

6338 - `"agent_archived_error"`

6339

63405987### Beta Managed Agents Cron Schedule

63415988

6342- `BetaManagedAgentsCronSchedule object { expression, timezone, type, 2 more }`

5989- `BetaManagedAgentsCronSchedule object`

63435990

63445991 5-field POSIX cron schedule with computed runtime timestamps.

63455992

from line 5994

63475994

63485995 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).

63495996

5997 minLength: 1, maxLength: 256

5998

63505999 - `timezone: string`

63516000

63526001 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

63536002

6003 minLength: 1

6004

63546005 - `type: "cron"`

63556006

6356 - `"cron"`

6357

63586007 - `last_run_at: optional string or null`

63596008

63606009 A timestamp in RFC 3339 format

63616010

6011 format: date-time

6012

63626013 - `upcoming_runs_at: optional array of string`

63636014

63646015 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.

63656016

63666017### Beta Managed Agents Cron Schedule Params

63676018

6368- `BetaManagedAgentsCronScheduleParams object { expression, timezone, type }`

6019- `BetaManagedAgentsCronScheduleParams object`

63696020

63706021 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

63716022

from line 6024

63736024

63746025 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).

63756026

6027 minLength: 1, maxLength: 256

6028

63766029 - `timezone: string`

63776030

63786031 Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

63796032

6033 minLength: 1

6034

63806035 - `type: "cron"`

63816036

6382 - `"cron"`

6383

63846037### Beta Managed Agents Deployment

63856038

6386- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`

6039- `BetaManagedAgentsDeployment object`

63876040

63886041 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.

63896042

from line 6052

63996052

64006053 - `type: "agent"`

64016054

6402 - `"agent"`

6403

64046055 - `version: number`

64056056

6057 format: int32

6058

64066059 - `archived_at: string or null`

64076060

64086061 A timestamp in RFC 3339 format

64096062

6063 format: date-time

6064

64106065 - `created_at: string`

64116066

64126067 A timestamp in RFC 3339 format

64136068

6069 format: date-time

6070

64146071 - `description: string or null`

64156072

64166073 Description of what the deployment does.

from line 6080

64236080

64246081 Events sent to each session immediately after creation.

64256082

6426 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

6083 - `BetaManagedAgentsDeploymentUserMessageEvent object`

64276084

64286085 A user message sent to the session.

64296086

from line 6088

64316088

64326089 Array of content blocks for the user message.

64336090

6434 - `BetaManagedAgentsTextBlock object { text, type }`

6091 - `BetaManagedAgentsTextBlock object`

64356092

64366093 Regular text content.

64376094

from line 6096

64396096

64406097 The text content.

64416098

6099 minLength: 1

6100

64426101 - `type: "text"`

64436102

6444 - `"text"`

6445

6446 - `BetaManagedAgentsImageBlock object { source, type }`

6103 - `BetaManagedAgentsImageBlock object`

64476104

64486105 Image content specified directly as base64 data or as a reference via a URL.

64496106

from line 6108

64516108

64526109 Union type for image source variants.

64536110

6454 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

6111 - `BetaManagedAgentsBase64ImageSource object`

64556112

64566113 Base64-encoded image data.

64576114

from line 6116

64596116

64606117 Base64-encoded image data.

64616118

6119 minLength: 1

6120

64626121 - `media_type: string`

64636122

64646123 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

64656124

6125 minLength: 1

6126

64666127 - `type: "base64"`

64676128

6468 - `"base64"`

6469

6470 - `BetaManagedAgentsURLImageSource object { type, url }`

6129 - `BetaManagedAgentsURLImageSource object`

64716130

64726131 Image referenced by URL.

64736132

64746133 - `type: "url"`

64756134

6476 - `"url"`

6477

64786135 - `url: string`

64796136

64806137 URL of the image to fetch.

64816138

6482 - `BetaManagedAgentsFileImageSource object { file_id, type }`

6139 minLength: 1

6140

6141 - `BetaManagedAgentsFileImageSource object`

64836142

64846143 Image referenced by file ID.

64856144

from line 6146

64876146

64886147 ID of a previously uploaded file.

64896148

6149 minLength: 1

6150

64906151 - `type: "file"`

64916152

6492 - `"file"`

6493

64946153 - `type: "image"`

64956154

6496 - `"image"`

6497

6498 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

6155 - `BetaManagedAgentsDocumentBlock object`

64996156

65006157 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

65016158

from line 6160

65036160

65046161 Union type for document source variants.

65056162

6506 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

6163 - `BetaManagedAgentsBase64DocumentSource object`

65076164

65086165 Base64-encoded document data.

65096166

from line 6168

65116168

65126169 Base64-encoded document data.

65136170

6171 minLength: 1

6172

65146173 - `media_type: string`

65156174

65166175 MIME type of the document (e.g., "application/pdf").

65176176

6177 minLength: 1

6178

65186179 - `type: "base64"`

65196180

6520 - `"base64"`

6521

6522 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

6181 - `BetaManagedAgentsPlainTextDocumentSource object`

65236182

65246183 Plain text document content.

65256184

from line 6186

65276186

65286187 The plain text content.

65296188

6189 minLength: 1

6190

65306191 - `media_type: "text/plain"`

65316192

65326193 MIME type of the text content. Must be "text/plain".

65336194

6534 - `"text/plain"`

6535

65366195 - `type: "text"`

65376196

6538 - `"text"`

6539

6540 - `BetaManagedAgentsURLDocumentSource object { type, url }`

6197 - `BetaManagedAgentsURLDocumentSource object`

65416198

65426199 Document referenced by URL.

65436200

65446201 - `type: "url"`

65456202

6546 - `"url"`

6547

65486203 - `url: string`

65496204

65506205 URL of the document to fetch.

65516206

6552 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

6207 minLength: 1

6208

6209 - `BetaManagedAgentsFileDocumentSource object`

65536210

65546211 Document referenced by file ID.

65556212

from line 6214

65576214

65586215 ID of a previously uploaded file.

65596216

6217 minLength: 1

6218

65606219 - `type: "file"`

65616220

6562 - `"file"`

6563

65646221 - `type: "document"`

65656222

6566 - `"document"`

6567

65686223 - `context: optional string or null`

65696224

65706225 Additional context about the document for the model.

from line 6228

65736228

65746229 The title of the document.

65756230

6576 - `BetaManagedAgentsRedactedBlock object { type }`

6231 - `BetaManagedAgentsRedactedBlock object`

65776232

65786233 Placeholder for content withheld by Anthropic model policy.

65796234

65806235 - `type: "redacted"`

65816236

6582 - `"redacted"`

6583

65846237 - `type: "user.message"`

65856238

6586 - `"user.message"`

6587

6588 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

6239 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

65896240

65906241 An outcome the agent should work toward. The agent begins work on receipt.

65916242

from line 6248

65976248

65986249 Rubric for grading the quality of an outcome.

65996250

6600 - `BetaManagedAgentsFileRubric object { file_id, type }`

6251 - `BetaManagedAgentsFileRubric object`

66016252

66026253 Rubric referenced by a file uploaded via the Files API.

66036254

from line 6258

66076258

66086259 - `type: "file"`

66096260

6610 - `"file"`

6611

6612 - `BetaManagedAgentsTextRubric object { content, type }`

6261 - `BetaManagedAgentsTextRubric object`

66136262

66146263 Rubric content provided inline as text.

66156264

from line 6268

66196268

66206269 - `type: "text"`

66216270

6622 - `"text"`

6623

66246271 - `type: "user.define_outcome"`

66256272

6626 - `"user.define_outcome"`

6627

66286273 - `max_iterations: optional number or null`

66296274

66306275 Eval→revision cycles before giving up. Default 3, max 20.

66316276

6632 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

6277 format: int32

6278

6279 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

66336280

66346281 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.

66356282

from line 6288

66416288

66426289 The text content.

66436290

6291 minLength: 1

6292

66446293 - `type: "text"`

66456294

6646 - `"text"`

6647

66486295 - `type: "system.message"`

66496296

6650 - `"system.message"`

6651

66526297 - `metadata: map[string]`

66536298

66546299 Arbitrary key-value metadata. Maximum 16 pairs.

from line 6306

66616306

66626307 Why a deployment is paused. Non-null exactly when `status` is `paused`.

66636308

6664 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

6309 - `BetaManagedAgentsManualDeploymentPausedReason object`

66656310

66666311 The caller invoked the pause endpoint on the deployment.

66676312

66686313 - `type: "manual"`

66696314

6670 - `"manual"`

6671

6672 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

6315 - `BetaManagedAgentsErrorDeploymentPausedReason object`

66736316

66746317 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

66756318

from line 6320

66776320

66786321 The error that triggered an auto-pause. Matches the failed run's `error.type`.

66796322

6680 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

6323 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

66816324

66826325 The deployment's environment was archived.

66836326

66846327 - `type: "environment_archived_error"`

66856328

6686 - `"environment_archived_error"`

6687

6688 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

6329 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

66896330

66906331 The deployment's agent was archived.

66916332

66926333 - `type: "agent_archived_error"`

66936334

6694 - `"agent_archived_error"`

6695

6696 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

6335 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

66976336

66986337 The deployment's environment no longer exists.

66996338

67006339 - `type: "environment_not_found_error"`

67016340

6702 - `"environment_not_found_error"`

6703

6704 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

6341 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

67056342

67066343 A vault referenced by the deployment no longer exists.

67076344

67086345 - `type: "vault_not_found_error"`

67096346

6710 - `"vault_not_found_error"`

6711

6712 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

6347 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

67136348

67146349 A file resource referenced by the deployment no longer exists.

67156350

67166351 - `type: "file_not_found_error"`

67176352

6718 - `"file_not_found_error"`

6719

6720 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

6353 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

67216354

67226355 A referenced resource no longer exists and its kind was not reported.

67236356

67246357 - `type: "session_resource_not_found_error"`

67256358

6726 - `"session_resource_not_found_error"`

6727

6728 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

6359 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

67296360

67306361 The deployment's workspace was archived.

67316362

67326363 - `type: "workspace_archived_error"`

67336364

6734 - `"workspace_archived_error"`

6735

6736 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

6365 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

67376366

67386367 The deployment's organization is disabled.

67396368

67406369 - `type: "organization_disabled_error"`

67416370

6742 - `"organization_disabled_error"`

6743

6744 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

6371 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

67456372

67466373 A memory store referenced by the deployment is archived.

67476374

67486375 - `type: "memory_store_archived_error"`

67496376

6750 - `"memory_store_archived_error"`

6751

6752 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

6377 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

67536378

67546379 A skill referenced by the deployment's agent no longer exists.

67556380

67566381 - `type: "skill_not_found_error"`

67576382

6758 - `"skill_not_found_error"`

6759

6760 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

6383 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

67616384

67626385 A vault referenced by the deployment is archived.

67636386

67646387 - `type: "vault_archived_error"`

67656388

6766 - `"vault_archived_error"`

6767

6768 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

6389 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

67696390

67706391 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

67716392

67726393 - `type: "unknown_error"`

67736394

6774 - `"unknown_error"`

6775

6776 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

6395 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

67776396

67786397 The deployment configures resources, but its environment is self-hosted and cannot mount them.

67796398

67806399 - `type: "self_hosted_resources_unsupported_error"`

67816400

6782 - `"self_hosted_resources_unsupported_error"`

6783

6784 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

6401 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

67856402

67866403 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

67876404

67886405 - `type: "mcp_egress_blocked_error"`

67896406

6790 - `"mcp_egress_blocked_error"`

6791

67926407 - `type: "error"`

67936408

6794 - `"error"`

6795

67966409 - `resources: array of BetaManagedAgentsSessionResourceConfig`

67976410

67986411 Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

67996412

6800 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

6413 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

68016414

68026415 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

68036416

68046417 - `type: "github_repository"`

68056418

6806 - `"github_repository"`

6807

68086419 - `url: string`

68096420

68106421 Github URL of the repository

from line 6424

68136424

68146425 Branch or commit to check out. Defaults to the repository's default branch.

68156426

6816 - `BetaManagedAgentsBranchCheckout object { name, type }`

6427 - `BetaManagedAgentsBranchCheckout object`

68176428

68186429 - `name: string`

68196430

68206431 Branch name to check out.

68216432

6433 minLength: 1, maxLength: 255

6434

68226435 - `type: "branch"`

68236436

6824 - `"branch"`

6825

6826 - `BetaManagedAgentsCommitCheckout object { sha, type }`

6437 - `BetaManagedAgentsCommitCheckout object`

68276438

68286439 - `sha: string`

68296440

68306441 Full commit SHA to check out.

68316442

6443 minLength: 7, maxLength: 64

6444

68326445 - `type: "commit"`

68336446

6834 - `"commit"`

6835

68366447 - `mount_path: optional string or null`

68376448

68386449 Mount path in the container. Defaults to `/workspace/<repo-name>`.

68396450

6840 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

6451 - `BetaManagedAgentsFileResourceConfig object`

68416452

68426453 A file mounted into each session's container.

68436454

from line 6458

68476458

68486459 - `type: "file"`

68496460

6850 - `"file"`

6851

68526461 - `mount_path: optional string or null`

68536462

68546463 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

68556464

6856 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

6465 - `BetaManagedAgentsMemoryStoreResourceConfig object`

68576466

68586467 A memory store attached to each session created from this deployment.

68596468

from line 6472

68636472

68646473 - `type: "memory_store"`

68656474

6866 - `"memory_store"`

6867

68686475 - `access: optional "read_write" or "read_only" or null`

68696476

68706477 Access mode for an attached memory store.

from line 6492

68856492

68866493 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).

68876494

6495 minLength: 1, maxLength: 256

6496

68886497 - `timezone: string`

68896498

68906499 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

68916500

6501 minLength: 1

6502

68926503 - `type: "cron"`

68936504

6894 - `"cron"`

6895

68966505 - `last_run_at: optional string or null`

68976506

68986507 A timestamp in RFC 3339 format

68996508

6509 format: date-time

6510

69006511 - `upcoming_runs_at: optional array of string`

69016512

69026513 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 6522

69116522

69126523 - `type: "deployment"`

69136524

6914 - `"deployment"`

6915

69166525 - `updated_at: string`

69176526

69186527 A timestamp in RFC 3339 format

69196528

6529 format: date-time

6530

69206531 - `vault_ids: array of string`

69216532

69226533 Vault IDs supplying stored credentials for sessions created from this deployment.

from line 6548

69376548

69386549 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.

69396550

6940 - `"USD"`

6941

69426551 - `type: "limit"`

69436552

6944 - `"limit"`

6945

69466553### Beta Managed Agents Deployment Initial Event

69476554

69486555- `BetaManagedAgentsDeploymentInitialEvent = BetaManagedAgentsDeploymentUserMessageEvent or BetaManagedAgentsDeploymentUserDefineOutcomeEvent or BetaManagedAgentsDeploymentSystemMessageEvent`

69496556

69506557 An event sent to a session immediately after it is created. Supports `user.message`, `user.define_outcome`, and `system.message`.

69516558

6952 - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

6559 - `BetaManagedAgentsDeploymentUserMessageEvent object`

69536560

69546561 A user message sent to the session.

69556562

from line 6564

69576564

69586565 Array of content blocks for the user message.

69596566

6960 - `BetaManagedAgentsTextBlock object { text, type }`

6567 - `BetaManagedAgentsTextBlock object`

69616568

69626569 Regular text content.

69636570

from line 6572

69656572

69666573 The text content.

69676574

6575 minLength: 1

6576

69686577 - `type: "text"`

69696578

6970 - `"text"`

6971

6972 - `BetaManagedAgentsImageBlock object { source, type }`

6579 - `BetaManagedAgentsImageBlock object`

69736580

69746581 Image content specified directly as base64 data or as a reference via a URL.

69756582

from line 6584

69776584

69786585 Union type for image source variants.

69796586

6980 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

6587 - `BetaManagedAgentsBase64ImageSource object`

69816588

69826589 Base64-encoded image data.

69836590

from line 6592

69856592

69866593 Base64-encoded image data.

69876594

6595 minLength: 1

6596

69886597 - `media_type: string`

69896598

69906599 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

69916600

6601 minLength: 1

6602

69926603 - `type: "base64"`

69936604

6994 - `"base64"`

6995

6996 - `BetaManagedAgentsURLImageSource object { type, url }`

6605 - `BetaManagedAgentsURLImageSource object`

69976606

69986607 Image referenced by URL.

69996608

70006609 - `type: "url"`

70016610

7002 - `"url"`

7003

70046611 - `url: string`

70056612

70066613 URL of the image to fetch.

70076614

7008 - `BetaManagedAgentsFileImageSource object { file_id, type }`

6615 minLength: 1

6616

6617 - `BetaManagedAgentsFileImageSource object`

70096618

70106619 Image referenced by file ID.

70116620

from line 6622

70136622

70146623 ID of a previously uploaded file.

70156624

6625 minLength: 1

6626

70166627 - `type: "file"`

70176628

7018 - `"file"`

7019

70206629 - `type: "image"`

70216630

7022 - `"image"`

7023

7024 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

6631 - `BetaManagedAgentsDocumentBlock object`

70256632

70266633 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

70276634

from line 6636

70296636

70306637 Union type for document source variants.

70316638

7032 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

6639 - `BetaManagedAgentsBase64DocumentSource object`

70336640

70346641 Base64-encoded document data.

70356642

from line 6644

70376644

70386645 Base64-encoded document data.

70396646

6647 minLength: 1

6648

70406649 - `media_type: string`

70416650

70426651 MIME type of the document (e.g., "application/pdf").

70436652

6653 minLength: 1

6654

70446655 - `type: "base64"`

70456656

7046 - `"base64"`

7047

7048 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

6657 - `BetaManagedAgentsPlainTextDocumentSource object`

70496658

70506659 Plain text document content.

70516660

from line 6662

70536662

70546663 The plain text content.

70556664

6665 minLength: 1

6666

70566667 - `media_type: "text/plain"`

70576668

70586669 MIME type of the text content. Must be "text/plain".

70596670

7060 - `"text/plain"`

7061

70626671 - `type: "text"`

70636672

7064 - `"text"`

7065

7066 - `BetaManagedAgentsURLDocumentSource object { type, url }`

6673 - `BetaManagedAgentsURLDocumentSource object`

70676674

70686675 Document referenced by URL.

70696676

70706677 - `type: "url"`

70716678

7072 - `"url"`

7073

70746679 - `url: string`

70756680

70766681 URL of the document to fetch.

70776682

7078 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

6683 minLength: 1

6684

6685 - `BetaManagedAgentsFileDocumentSource object`

70796686

70806687 Document referenced by file ID.

70816688

from line 6690

70836690

70846691 ID of a previously uploaded file.

70856692

6693 minLength: 1

6694

70866695 - `type: "file"`

70876696

7088 - `"file"`

7089

70906697 - `type: "document"`

70916698

7092 - `"document"`

7093

70946699 - `context: optional string or null`

70956700

70966701 Additional context about the document for the model.

from line 6704

70996704

71006705 The title of the document.

71016706

7102 - `BetaManagedAgentsRedactedBlock object { type }`

6707 - `BetaManagedAgentsRedactedBlock object`

71036708

71046709 Placeholder for content withheld by Anthropic model policy.

71056710

71066711 - `type: "redacted"`

71076712

7108 - `"redacted"`

7109

71106713 - `type: "user.message"`

71116714

7112 - `"user.message"`

7113

7114 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

6715 - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

71156716

71166717 An outcome the agent should work toward. The agent begins work on receipt.

71176718

from line 6724

71236724

71246725 Rubric for grading the quality of an outcome.

71256726

7126 - `BetaManagedAgentsFileRubric object { file_id, type }`

6727 - `BetaManagedAgentsFileRubric object`

71276728

71286729 Rubric referenced by a file uploaded via the Files API.

71296730

from line 6734

71336734

71346735 - `type: "file"`

71356736

7136 - `"file"`

7137

7138 - `BetaManagedAgentsTextRubric object { content, type }`

6737 - `BetaManagedAgentsTextRubric object`

71396738

71406739 Rubric content provided inline as text.

71416740

from line 6744

71456744

71466745 - `type: "text"`

71476746

7148 - `"text"`

7149

71506747 - `type: "user.define_outcome"`

71516748

7152 - `"user.define_outcome"`

7153

71546749 - `max_iterations: optional number or null`

71556750

71566751 Eval→revision cycles before giving up. Default 3, max 20.

71576752

7158 - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

6753 format: int32

6754

6755 - `BetaManagedAgentsDeploymentSystemMessageEvent object`

71596756

71606757 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.

71616758

from line 6764

71676764

71686765 The text content.

71696766

6767 minLength: 1

6768

71706769 - `type: "text"`

71716770

7172 - `"text"`

7173

71746771 - `type: "system.message"`

71756772

7176 - `"system.message"`

7177

71786773### Beta Managed Agents Deployment Initial Event Params

71796774

71806775- `BetaManagedAgentsDeploymentInitialEventParams = BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams or BetaManagedAgentsSystemMessageEventParams`

71816776

71826777 An event sent to a session immediately after it is created. Supports `user.message`, `user.define_outcome`, and `system.message`.

71836778

7184 - `BetaManagedAgentsUserMessageEventParams object { content, type }`

6779 - `BetaManagedAgentsUserMessageEventParams object`

71856780

71866781 Parameters for sending a user message to the session.

71876782

from line 6784

71896784

71906785 Array of content blocks for the user message.

71916786

7192 - `BetaManagedAgentsTextBlock object { text, type }`

6787 - `BetaManagedAgentsTextBlock object`

71936788

71946789 Regular text content.

71956790

from line 6792

71976792

71986793 The text content.

71996794

6795 minLength: 1

6796

72006797 - `type: "text"`

72016798

7202 - `"text"`

7203

7204 - `BetaManagedAgentsImageBlock object { source, type }`

6799 - `BetaManagedAgentsImageBlock object`

72056800

72066801 Image content specified directly as base64 data or as a reference via a URL.

72076802

from line 6804

72096804

72106805 Union type for image source variants.

72116806

7212 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

6807 - `BetaManagedAgentsBase64ImageSource object`

72136808

72146809 Base64-encoded image data.

72156810

from line 6812

72176812

72186813 Base64-encoded image data.

72196814

6815 minLength: 1

6816

72206817 - `media_type: string`

72216818

72226819 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

72236820

6821 minLength: 1

6822

72246823 - `type: "base64"`

72256824

7226 - `"base64"`

7227

7228 - `BetaManagedAgentsURLImageSource object { type, url }`

6825 - `BetaManagedAgentsURLImageSource object`

72296826

72306827 Image referenced by URL.

72316828

72326829 - `type: "url"`

72336830

7234 - `"url"`

7235

72366831 - `url: string`

72376832

72386833 URL of the image to fetch.

72396834

7240 - `BetaManagedAgentsFileImageSource object { file_id, type }`

6835 minLength: 1

6836

6837 - `BetaManagedAgentsFileImageSource object`

72416838

72426839 Image referenced by file ID.

72436840

from line 6842

72456842

72466843 ID of a previously uploaded file.

72476844

6845 minLength: 1

6846

72486847 - `type: "file"`

72496848

7250 - `"file"`

7251

72526849 - `type: "image"`

72536850

7254 - `"image"`

7255

7256 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

6851 - `BetaManagedAgentsDocumentBlock object`

72576852

72586853 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

72596854

from line 6856

72616856

72626857 Union type for document source variants.

72636858

7264 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

6859 - `BetaManagedAgentsBase64DocumentSource object`

72656860

72666861 Base64-encoded document data.

72676862

from line 6864

72696864

72706865 Base64-encoded document data.

72716866

6867 minLength: 1

6868

72726869 - `media_type: string`

72736870

72746871 MIME type of the document (e.g., "application/pdf").

72756872

6873 minLength: 1

6874

72766875 - `type: "base64"`

72776876

7278 - `"base64"`

7279

7280 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

6877 - `BetaManagedAgentsPlainTextDocumentSource object`

72816878

72826879 Plain text document content.

72836880

from line 6882

72856882

72866883 The plain text content.

72876884

6885 minLength: 1

6886

72886887 - `media_type: "text/plain"`

72896888

72906889 MIME type of the text content. Must be "text/plain".

72916890

7292 - `"text/plain"`

7293

72946891 - `type: "text"`

72956892

7296 - `"text"`

7297

7298 - `BetaManagedAgentsURLDocumentSource object { type, url }`

6893 - `BetaManagedAgentsURLDocumentSource object`

72996894

73006895 Document referenced by URL.

73016896

73026897 - `type: "url"`

73036898

7304 - `"url"`

7305

73066899 - `url: string`

73076900

73086901 URL of the document to fetch.

73096902

7310 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

6903 minLength: 1

6904

6905 - `BetaManagedAgentsFileDocumentSource object`

73116906

73126907 Document referenced by file ID.

73136908

from line 6910

73156910

73166911 ID of a previously uploaded file.

73176912

6913 minLength: 1

6914

73186915 - `type: "file"`

73196916

7320 - `"file"`

7321

73226917 - `type: "document"`

73236918

7324 - `"document"`

7325

73266919 - `context: optional string or null`

73276920

73286921 Additional context about the document for the model.

from line 6924

73316924

73326925 The title of the document.

73336926

7334 - `BetaManagedAgentsRedactedBlock object { type }`

6927 - `BetaManagedAgentsRedactedBlock object`

73356928

73366929 Placeholder for content withheld by Anthropic model policy.

73376930

73386931 - `type: "redacted"`

73396932

7340 - `"redacted"`

7341

73426933 - `type: "user.message"`

73436934

7344 - `"user.message"`

7345

7346 - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`

6935 - `BetaManagedAgentsUserDefineOutcomeEventParams object`

73476936

73486937 Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

73496938

from line 6944

73556944

73566945 Rubric for grading the quality of an outcome.

73576946

7358 - `BetaManagedAgentsFileRubricParams object { file_id, type }`

6947 - `BetaManagedAgentsFileRubricParams object`

73596948

73606949 Rubric referenced by a file uploaded via the Files API.

73616950

from line 6954

73656954

73666955 - `type: "file"`

73676956

7368 - `"file"`

7369

7370 - `BetaManagedAgentsTextRubricParams object { content, type }`

6957 - `BetaManagedAgentsTextRubricParams object`

73716958

73726959 Rubric content provided inline as text.

73736960

from line 6962

73756962

73766963 Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.

73776964

6965 maxLength: 262144

6966

73786967 - `type: "text"`

73796968

7380 - `"text"`

7381

73826969 - `type: "user.define_outcome"`

73836970

7384 - `"user.define_outcome"`

7385

73866971 - `max_iterations: optional number or null`

73876972

73886973 Eval→revision cycles before giving up. Default 3, max 20.

73896974

7390 - `BetaManagedAgentsSystemMessageEventParams object { content, type }`

6975 format: int32

6976

6977 - `BetaManagedAgentsSystemMessageEventParams object`

73916978

73926979 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.

73936980

from line 6986

73996986

74006987 The text content.

74016988

6989 minLength: 1

6990

74026991 - `type: "text"`

74036992

7404 - `"text"`

7405

74066993 - `type: "system.message"`

74076994

7408 - `"system.message"`

7409

74106995### Beta Managed Agents Deployment Paused Reason

74116996

74126997- `BetaManagedAgentsDeploymentPausedReason = BetaManagedAgentsManualDeploymentPausedReason or BetaManagedAgentsErrorDeploymentPausedReason`

74136998

74146999 Why a deployment is paused. Non-null exactly when `status` is `paused`.

74157000

7416 - `BetaManagedAgentsManualDeploymentPausedReason object { type }`

7001 - `BetaManagedAgentsManualDeploymentPausedReason object`

74177002

74187003 The caller invoked the pause endpoint on the deployment.

74197004

74207005 - `type: "manual"`

74217006

7422 - `"manual"`

7423

7424 - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

7007 - `BetaManagedAgentsErrorDeploymentPausedReason object`

74257008

74267009 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

74277010

from line 7012

74297012

74307013 The error that triggered an auto-pause. Matches the failed run's `error.type`.

74317014

7432 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

7015 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

74337016

74347017 The deployment's environment was archived.

74357018

74367019 - `type: "environment_archived_error"`

74377020

7438 - `"environment_archived_error"`

7439

7440 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

7021 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

74417022

74427023 The deployment's agent was archived.

74437024

74447025 - `type: "agent_archived_error"`

74457026

7446 - `"agent_archived_error"`

7447

7448 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

7027 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

74497028

74507029 The deployment's environment no longer exists.

74517030

74527031 - `type: "environment_not_found_error"`

74537032

7454 - `"environment_not_found_error"`

7455

7456 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

7033 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

74577034

74587035 A vault referenced by the deployment no longer exists.

74597036

74607037 - `type: "vault_not_found_error"`

74617038

7462 - `"vault_not_found_error"`

7463

7464 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

7039 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

74657040

74667041 A file resource referenced by the deployment no longer exists.

74677042

74687043 - `type: "file_not_found_error"`

74697044

7470 - `"file_not_found_error"`

7471

7472 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

7045 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

74737046

74747047 A referenced resource no longer exists and its kind was not reported.

74757048

74767049 - `type: "session_resource_not_found_error"`

74777050

7478 - `"session_resource_not_found_error"`

7479

7480 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

7051 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

74817052

74827053 The deployment's workspace was archived.

74837054

74847055 - `type: "workspace_archived_error"`

74857056

7486 - `"workspace_archived_error"`

7487

7488 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

7057 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

74897058

74907059 The deployment's organization is disabled.

74917060

74927061 - `type: "organization_disabled_error"`

74937062

7494 - `"organization_disabled_error"`

7495

7496 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

7063 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

74977064

74987065 A memory store referenced by the deployment is archived.

74997066

75007067 - `type: "memory_store_archived_error"`

75017068

7502 - `"memory_store_archived_error"`

7503

7504 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

7069 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

75057070

75067071 A skill referenced by the deployment's agent no longer exists.

75077072

75087073 - `type: "skill_not_found_error"`

75097074

7510 - `"skill_not_found_error"`

7511

7512 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

7075 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

75137076

75147077 A vault referenced by the deployment is archived.

75157078

75167079 - `type: "vault_archived_error"`

75177080

7518 - `"vault_archived_error"`

7519

7520 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

7081 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

75217082

75227083 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

75237084

75247085 - `type: "unknown_error"`

75257086

7526 - `"unknown_error"`

7527

7528 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

7087 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

75297088

75307089 The deployment configures resources, but its environment is self-hosted and cannot mount them.

75317090

75327091 - `type: "self_hosted_resources_unsupported_error"`

75337092

7534 - `"self_hosted_resources_unsupported_error"`

7535

7536 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

7093 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

75377094

75387095 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

75397096

75407097 - `type: "mcp_egress_blocked_error"`

75417098

7542 - `"mcp_egress_blocked_error"`

7543

75447099 - `type: "error"`

75457100

7546 - `"error"`

7547

75487101### Beta Managed Agents Deployment Paused Reason Error

75497102

75507103- `BetaManagedAgentsDeploymentPausedReasonError = BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError or BetaManagedAgentsAgentArchivedDeploymentPausedReasonError or BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError or 11 more`

75517104

75527105 The error that triggered an auto-pause. Matches the failed run's `error.type`.

75537106

7554 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

7107 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

75557108

75567109 The deployment's environment was archived.

75577110

75587111 - `type: "environment_archived_error"`

75597112

7560 - `"environment_archived_error"`

7561

7562 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

7113 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

75637114

75647115 The deployment's agent was archived.

75657116

75667117 - `type: "agent_archived_error"`

75677118

7568 - `"agent_archived_error"`

7569

7570 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

7119 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

75717120

75727121 The deployment's environment no longer exists.

75737122

75747123 - `type: "environment_not_found_error"`

75757124

7576 - `"environment_not_found_error"`

7577

7578 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

7125 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

75797126

75807127 A vault referenced by the deployment no longer exists.

75817128

75827129 - `type: "vault_not_found_error"`

75837130

7584 - `"vault_not_found_error"`

7585

7586 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

7131 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

75877132

75887133 A file resource referenced by the deployment no longer exists.

75897134

75907135 - `type: "file_not_found_error"`

75917136

7592 - `"file_not_found_error"`

7593

7594 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

7137 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

75957138

75967139 A referenced resource no longer exists and its kind was not reported.

75977140

75987141 - `type: "session_resource_not_found_error"`

75997142

7600 - `"session_resource_not_found_error"`

7601

7602 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

7143 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

76037144

76047145 The deployment's workspace was archived.

76057146

76067147 - `type: "workspace_archived_error"`

76077148

7608 - `"workspace_archived_error"`

7609

7610 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

7149 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

76117150

76127151 The deployment's organization is disabled.

76137152

76147153 - `type: "organization_disabled_error"`

76157154

7616 - `"organization_disabled_error"`

7617

7618 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

7155 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

76197156

76207157 A memory store referenced by the deployment is archived.

76217158

76227159 - `type: "memory_store_archived_error"`

76237160

7624 - `"memory_store_archived_error"`

7625

7626 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

7161 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

76277162

76287163 A skill referenced by the deployment's agent no longer exists.

76297164

76307165 - `type: "skill_not_found_error"`

76317166

7632 - `"skill_not_found_error"`

7633

7634 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

7167 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

76357168

76367169 A vault referenced by the deployment is archived.

76377170

76387171 - `type: "vault_archived_error"`

76397172

7640 - `"vault_archived_error"`

7641

7642 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

7173 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

76437174

76447175 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

76457176

76467177 - `type: "unknown_error"`

76477178

7648 - `"unknown_error"`

7649

7650 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

7179 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

76517180

76527181 The deployment configures resources, but its environment is self-hosted and cannot mount them.

76537182

76547183 - `type: "self_hosted_resources_unsupported_error"`

76557184

7656 - `"self_hosted_resources_unsupported_error"`

7657

7658 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

7185 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

76597186

76607187 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

76617188

76627189 - `type: "mcp_egress_blocked_error"`

76637190

7664 - `"mcp_egress_blocked_error"`

7665

76667191### Beta Managed Agents Deployment Status

76677192

76687193- `BetaManagedAgentsDeploymentStatus = "active" or "paused"`

from line 7200

76757200

76767201### Beta Managed Agents Deployment System Message Event

76777202

7678- `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }`

7203- `BetaManagedAgentsDeploymentSystemMessageEvent object`

76797204

76807205 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.

76817206

from line 7212

76877212

76887213 The text content.

76897214

7215 minLength: 1

7216

76907217 - `type: "text"`

76917218

7692 - `"text"`

7693

76947219 - `type: "system.message"`

76957220

7696 - `"system.message"`

7697

76987221### Beta Managed Agents Deployment User Define Outcome Event

76997222

7700- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`

7223- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`

77017224

77027225 An outcome the agent should work toward. The agent begins work on receipt.

77037226

from line 7232

77097232

77107233 Rubric for grading the quality of an outcome.

77117234

7712 - `BetaManagedAgentsFileRubric object { file_id, type }`

7235 - `BetaManagedAgentsFileRubric object`

77137236

77147237 Rubric referenced by a file uploaded via the Files API.

77157238

from line 7242

77197242

77207243 - `type: "file"`

77217244

7722 - `"file"`

7723

7724 - `BetaManagedAgentsTextRubric object { content, type }`

7245 - `BetaManagedAgentsTextRubric object`

77257246

77267247 Rubric content provided inline as text.

77277248

from line 7252

77317252

77327253 - `type: "text"`

77337254

7734 - `"text"`

7735

77367255 - `type: "user.define_outcome"`

77377256

7738 - `"user.define_outcome"`

7739

77407257 - `max_iterations: optional number or null`

77417258

77427259 Eval→revision cycles before giving up. Default 3, max 20.

77437260

7261 format: int32

7262

77447263### Beta Managed Agents Deployment User Message Event

77457264

7746- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`

7265- `BetaManagedAgentsDeploymentUserMessageEvent object`

77477266

77487267 A user message sent to the session.

77497268

from line 7270

77517270

77527271 Array of content blocks for the user message.

77537272

7754 - `BetaManagedAgentsTextBlock object { text, type }`

7273 - `BetaManagedAgentsTextBlock object`

77557274

77567275 Regular text content.

77577276

from line 7278

77597278

77607279 The text content.

77617280

7281 minLength: 1

7282

77627283 - `type: "text"`

77637284

7764 - `"text"`

7765

7766 - `BetaManagedAgentsImageBlock object { source, type }`

7285 - `BetaManagedAgentsImageBlock object`

77677286

77687287 Image content specified directly as base64 data or as a reference via a URL.

77697288

from line 7290

77717290

77727291 Union type for image source variants.

77737292

7774 - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`

7293 - `BetaManagedAgentsBase64ImageSource object`

77757294

77767295 Base64-encoded image data.

77777296

from line 7298

77797298

77807299 Base64-encoded image data.

77817300

7301 minLength: 1

7302

77827303 - `media_type: string`

77837304

77847305 MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").

77857306

7307 minLength: 1

7308

77867309 - `type: "base64"`

77877310

7788 - `"base64"`

7789

7790 - `BetaManagedAgentsURLImageSource object { type, url }`

7311 - `BetaManagedAgentsURLImageSource object`

77917312

77927313 Image referenced by URL.

77937314

77947315 - `type: "url"`

77957316

7796 - `"url"`

7797

77987317 - `url: string`

77997318

78007319 URL of the image to fetch.

78017320

7802 - `BetaManagedAgentsFileImageSource object { file_id, type }`

7321 minLength: 1

7322

7323 - `BetaManagedAgentsFileImageSource object`

78037324

78047325 Image referenced by file ID.

78057326

from line 7328

78077328

78087329 ID of a previously uploaded file.

78097330

7331 minLength: 1

7332

78107333 - `type: "file"`

78117334

7812 - `"file"`

7813

78147335 - `type: "image"`

78157336

7816 - `"image"`

7817

7818 - `BetaManagedAgentsDocumentBlock object { source, type, context, title }`

7337 - `BetaManagedAgentsDocumentBlock object`

78197338

78207339 Document content, either specified directly as base64 data, as text, or as a reference via a URL.

78217340

from line 7342

78237342

78247343 Union type for document source variants.

78257344

7826 - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`

7345 - `BetaManagedAgentsBase64DocumentSource object`

78277346

78287347 Base64-encoded document data.

78297348

from line 7350

78317350

78327351 Base64-encoded document data.

78337352

7353 minLength: 1

7354

78347355 - `media_type: string`

78357356

78367357 MIME type of the document (e.g., "application/pdf").

78377358

7359 minLength: 1

7360

78387361 - `type: "base64"`

78397362

7840 - `"base64"`

7841

7842 - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`

7363 - `BetaManagedAgentsPlainTextDocumentSource object`

78437364

78447365 Plain text document content.

78457366

from line 7368

78477368

78487369 The plain text content.

78497370

7371 minLength: 1

7372

78507373 - `media_type: "text/plain"`

78517374

78527375 MIME type of the text content. Must be "text/plain".

78537376

7854 - `"text/plain"`

7855

78567377 - `type: "text"`

78577378

7858 - `"text"`

7859

7860 - `BetaManagedAgentsURLDocumentSource object { type, url }`

7379 - `BetaManagedAgentsURLDocumentSource object`

78617380

78627381 Document referenced by URL.

78637382

78647383 - `type: "url"`

78657384

7866 - `"url"`

7867

78687385 - `url: string`

78697386

78707387 URL of the document to fetch.

78717388

7872 - `BetaManagedAgentsFileDocumentSource object { file_id, type }`

7389 minLength: 1

7390

7391 - `BetaManagedAgentsFileDocumentSource object`

78737392

78747393 Document referenced by file ID.

78757394

from line 7396

78777396

78787397 ID of a previously uploaded file.

78797398

7399 minLength: 1

7400

78807401 - `type: "file"`

78817402

7882 - `"file"`

7883

78847403 - `type: "document"`

78857404

7886 - `"document"`

7887

78887405 - `context: optional string or null`

78897406

78907407 Additional context about the document for the model.

from line 7410

78937410

78947411 The title of the document.

78957412

7896 - `BetaManagedAgentsRedactedBlock object { type }`

7413 - `BetaManagedAgentsRedactedBlock object`

78977414

78987415 Placeholder for content withheld by Anthropic model policy.

78997416

79007417 - `type: "redacted"`

79017418

7902 - `"redacted"`

7903

79047419 - `type: "user.message"`

79057420

7906 - `"user.message"`

7907

79087421### Beta Managed Agents Environment Archived Deployment Paused Reason Error

79097422

7910- `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

7423- `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

79117424

79127425 The deployment's environment was archived.

79137426

79147427 - `type: "environment_archived_error"`

79157428

7916 - `"environment_archived_error"`

7917

79187429### Beta Managed Agents Environment Not Found Deployment Paused Reason Error

79197430

7920- `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

7431- `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

79217432

79227433 The deployment's environment no longer exists.

79237434

79247435 - `type: "environment_not_found_error"`

79257436

7926 - `"environment_not_found_error"`

7927

79287437### Beta Managed Agents Error Deployment Paused Reason

79297438

7930- `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }`

7439- `BetaManagedAgentsErrorDeploymentPausedReason object`

79317440

79327441 A scheduled fire recorded a failed run whose error auto-pauses the deployment.

79337442

from line 7444

79357444

79367445 The error that triggered an auto-pause. Matches the failed run's `error.type`.

79377446

7938 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }`

7447 - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`

79397448

79407449 The deployment's environment was archived.

79417450

79427451 - `type: "environment_archived_error"`

79437452

7944 - `"environment_archived_error"`

7945

7946 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }`

7453 - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`

79477454

79487455 The deployment's agent was archived.

79497456

79507457 - `type: "agent_archived_error"`

79517458

7952 - `"agent_archived_error"`

7953

7954 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }`

7459 - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`

79557460

79567461 The deployment's environment no longer exists.

79577462

79587463 - `type: "environment_not_found_error"`

79597464

7960 - `"environment_not_found_error"`

7961

7962 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

7465 - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

79637466

79647467 A vault referenced by the deployment no longer exists.

79657468

79667469 - `type: "vault_not_found_error"`

79677470

7968 - `"vault_not_found_error"`

7969

7970 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

7471 - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

79717472

79727473 A file resource referenced by the deployment no longer exists.

79737474

79747475 - `type: "file_not_found_error"`

79757476

7976 - `"file_not_found_error"`

7977

7978 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

7477 - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

79797478

79807479 A referenced resource no longer exists and its kind was not reported.

79817480

79827481 - `type: "session_resource_not_found_error"`

79837482

7984 - `"session_resource_not_found_error"`

7985

7986 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

7483 - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

79877484

79887485 The deployment's workspace was archived.

79897486

79907487 - `type: "workspace_archived_error"`

79917488

7992 - `"workspace_archived_error"`

7993

7994 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

7489 - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

79957490

79967491 The deployment's organization is disabled.

79977492

79987493 - `type: "organization_disabled_error"`

79997494

8000 - `"organization_disabled_error"`

8001

8002 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

7495 - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

80037496

80047497 A memory store referenced by the deployment is archived.

80057498

80067499 - `type: "memory_store_archived_error"`

80077500

8008 - `"memory_store_archived_error"`

8009

8010 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

7501 - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

80117502

80127503 A skill referenced by the deployment's agent no longer exists.

80137504

80147505 - `type: "skill_not_found_error"`

80157506

8016 - `"skill_not_found_error"`

8017

8018 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

7507 - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

80197508

80207509 A vault referenced by the deployment is archived.

80217510

80227511 - `type: "vault_archived_error"`

80237512

8024 - `"vault_archived_error"`

8025

8026 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

7513 - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

80277514

80287515 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

80297516

80307517 - `type: "unknown_error"`

80317518

8032 - `"unknown_error"`

8033

8034 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

7519 - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

80357520

80367521 The deployment configures resources, but its environment is self-hosted and cannot mount them.

80377522

80387523 - `type: "self_hosted_resources_unsupported_error"`

80397524

8040 - `"self_hosted_resources_unsupported_error"`

8041

8042 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

7525 - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

80437526

80447527 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

80457528

80467529 - `type: "mcp_egress_blocked_error"`

80477530

8048 - `"mcp_egress_blocked_error"`

8049

80507531 - `type: "error"`

80517532

8052 - `"error"`

8053

80547533### Beta Managed Agents File Not Found Deployment Paused Reason Error

80557534

8056- `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }`

7535- `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`

80577536

80587537 A file resource referenced by the deployment no longer exists.

80597538

80607539 - `type: "file_not_found_error"`

80617540

8062 - `"file_not_found_error"`

8063

80647541### Beta Managed Agents File Resource Config

80657542

8066- `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

7543- `BetaManagedAgentsFileResourceConfig object`

80677544

80687545 A file mounted into each session's container.

80697546

from line 7550

80737550

80747551 - `type: "file"`

80757552

8076 - `"file"`

8077

80787553 - `mount_path: optional string or null`

80797554

80807555 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

80817556

80827557### Beta Managed Agents GitHub Repository Resource Config

80837558

8084- `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

7559- `BetaManagedAgentsGitHubRepositoryResourceConfig object`

80857560

80867561 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

80877562

80887563 - `type: "github_repository"`

80897564

8090 - `"github_repository"`

8091

80927565 - `url: string`

80937566

80947567 Github URL of the repository

from line 7570

80977570

80987571 Branch or commit to check out. Defaults to the repository's default branch.

80997572

8100 - `BetaManagedAgentsBranchCheckout object { name, type }`

7573 - `BetaManagedAgentsBranchCheckout object`

81017574

81027575 - `name: string`

81037576

81047577 Branch name to check out.

81057578

7579 minLength: 1, maxLength: 255

7580

81067581 - `type: "branch"`

81077582

8108 - `"branch"`

8109

8110 - `BetaManagedAgentsCommitCheckout object { sha, type }`

7583 - `BetaManagedAgentsCommitCheckout object`

81117584

81127585 - `sha: string`

81137586

81147587 Full commit SHA to check out.

81157588

7589 minLength: 7, maxLength: 64

7590

81167591 - `type: "commit"`

81177592

8118 - `"commit"`

8119

81207593 - `mount_path: optional string or null`

81217594

81227595 Mount path in the container. Defaults to `/workspace/<repo-name>`.

81237596

81247597### Beta Managed Agents Manual Deployment Paused Reason

81257598

8126- `BetaManagedAgentsManualDeploymentPausedReason object { type }`

7599- `BetaManagedAgentsManualDeploymentPausedReason object`

81277600

81287601 The caller invoked the pause endpoint on the deployment.

81297602

81307603 - `type: "manual"`

81317604

8132 - `"manual"`

8133

81347605### Beta Managed Agents MCP Egress Blocked Deployment Paused Reason Error

81357606

8136- `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }`

7607- `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`

81377608

81387609 An MCP server host used by the deployment's agent is blocked by the environment's network policy.

81397610

81407611 - `type: "mcp_egress_blocked_error"`

81417612

8142 - `"mcp_egress_blocked_error"`

8143

81447613### Beta Managed Agents Memory Store Archived Deployment Paused Reason Error

81457614

8146- `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }`

7615- `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`

81477616

81487617 A memory store referenced by the deployment is archived.

81497618

81507619 - `type: "memory_store_archived_error"`

81517620

8152 - `"memory_store_archived_error"`

8153

81547621### Beta Managed Agents Memory Store Resource Config

81557622

8156- `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

7623- `BetaManagedAgentsMemoryStoreResourceConfig object`

81577624

81587625 A memory store attached to each session created from this deployment.

81597626

from line 7630

81637630

81647631 - `type: "memory_store"`

81657632

8166 - `"memory_store"`

8167

81687633 - `access: optional "read_write" or "read_only" or null`

81697634

81707635 Access mode for an attached memory store.

from line 7644

81797644

81807645### Beta Managed Agents Organization Disabled Deployment Paused Reason Error

81817646

8182- `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }`

7647- `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`

81837648

81847649 The deployment's organization is disabled.

81857650

81867651 - `type: "organization_disabled_error"`

81877652

8188 - `"organization_disabled_error"`

8189

81907653### Beta Managed Agents Schedule

81917654

8192- `BetaManagedAgentsSchedule object { expression, timezone, type, 2 more }`

7655- `BetaManagedAgentsSchedule object`

81937656

81947657 5-field POSIX cron schedule with computed runtime timestamps.

81957658

from line 7660

81977660

81987661 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).

81997662

7663 minLength: 1, maxLength: 256

7664

82007665 - `timezone: string`

82017666

82027667 IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

82037668

7669 minLength: 1

7670

82047671 - `type: "cron"`

82057672

8206 - `"cron"`

8207

82087673 - `last_run_at: optional string or null`

82097674

82107675 A timestamp in RFC 3339 format

82117676

7677 format: date-time

7678

82127679 - `upcoming_runs_at: optional array of string`

82137680

82147681 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.

82157682

82167683### Beta Managed Agents Schedule Params

82177684

8218- `BetaManagedAgentsScheduleParams object { expression, timezone, type }`

7685- `BetaManagedAgentsScheduleParams object`

82197686

82207687 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

82217688

from line 7690

82237690

82247691 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).

82257692

7693 minLength: 1, maxLength: 256

7694

82267695 - `timezone: string`

82277696

82287697 Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

82297698

7699 minLength: 1

7700

82307701 - `type: "cron"`

82317702

8232 - `"cron"`

8233

82347703### Beta Managed Agents Self Hosted Resources Unsupported Deployment Paused Reason Error

82357704

8236- `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }`

7705- `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`

82377706

82387707 The deployment configures resources, but its environment is self-hosted and cannot mount them.

82397708

82407709 - `type: "self_hosted_resources_unsupported_error"`

82417710

8242 - `"self_hosted_resources_unsupported_error"`

8243

82447711### Beta Managed Agents Session Resource Config

82457712

82467713- `BetaManagedAgentsSessionResourceConfig = BetaManagedAgentsGitHubRepositoryResourceConfig or BetaManagedAgentsFileResourceConfig or BetaManagedAgentsMemoryStoreResourceConfig`

82477714

82487715 A configured session resource. Echoes the input minus write-only credentials.

82497716

8250 - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }`

7717 - `BetaManagedAgentsGitHubRepositoryResourceConfig object`

82517718

82527719 A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

82537720

82547721 - `type: "github_repository"`

82557722

8256 - `"github_repository"`

8257

82587723 - `url: string`

82597724

82607725 Github URL of the repository

from line 7728

82637728

82647729 Branch or commit to check out. Defaults to the repository's default branch.

82657730

8266 - `BetaManagedAgentsBranchCheckout object { name, type }`

7731 - `BetaManagedAgentsBranchCheckout object`

82677732

82687733 - `name: string`

82697734

82707735 Branch name to check out.

82717736

7737 minLength: 1, maxLength: 255

7738

82727739 - `type: "branch"`

82737740

8274 - `"branch"`

8275

8276 - `BetaManagedAgentsCommitCheckout object { sha, type }`

7741 - `BetaManagedAgentsCommitCheckout object`

82777742

82787743 - `sha: string`

82797744

82807745 Full commit SHA to check out.

82817746

7747 minLength: 7, maxLength: 64

7748

82827749 - `type: "commit"`

82837750

8284 - `"commit"`

8285

82867751 - `mount_path: optional string or null`

82877752

82887753 Mount path in the container. Defaults to `/workspace/<repo-name>`.

82897754

8290 - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }`

7755 - `BetaManagedAgentsFileResourceConfig object`

82917756

82927757 A file mounted into each session's container.

82937758

from line 7762

82977762

82987763 - `type: "file"`

82997764

8300 - `"file"`

8301

83027765 - `mount_path: optional string or null`

83037766

83047767 Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.

83057768

8306 - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }`

7769 - `BetaManagedAgentsMemoryStoreResourceConfig object`

83077770

83087771 A memory store attached to each session created from this deployment.

83097772

from line 7776

83137776

83147777 - `type: "memory_store"`

83157778

8316 - `"memory_store"`

8317

83187779 - `access: optional "read_write" or "read_only" or null`

83197780

83207781 Access mode for an attached memory store.

from line 7790

83297790

83307791### Beta Managed Agents Session Resource Not Found Deployment Paused Reason Error

83317792

8332- `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }`

7793- `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`

83337794

83347795 A referenced resource no longer exists and its kind was not reported.

83357796

83367797 - `type: "session_resource_not_found_error"`

83377798

8338 - `"session_resource_not_found_error"`

8339

83407799### Beta Managed Agents Skill Not Found Deployment Paused Reason Error

83417800

8342- `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }`

7801- `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`

83437802

83447803 A skill referenced by the deployment's agent no longer exists.

83457804

83467805 - `type: "skill_not_found_error"`

83477806

8348 - `"skill_not_found_error"`

8349

83507807### Beta Managed Agents Unknown Deployment Paused Reason Error

83517808

8352- `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }`

7809- `BetaManagedAgentsUnknownDeploymentPausedReasonError object`

83537810

83547811 An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.

83557812

83567813 - `type: "unknown_error"`

83577814

8358 - `"unknown_error"`

8359

83607815### Beta Managed Agents Vault Archived Deployment Paused Reason Error

83617816

8362- `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }`

7817- `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`

83637818

83647819 A vault referenced by the deployment is archived.

83657820

83667821 - `type: "vault_archived_error"`

83677822

8368 - `"vault_archived_error"`

8369

83707823### Beta Managed Agents Vault Not Found Deployment Paused Reason Error

83717824

8372- `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }`

7825- `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`

83737826

83747827 A vault referenced by the deployment no longer exists.

83757828

83767829 - `type: "vault_not_found_error"`

83777830

8378 - `"vault_not_found_error"`

8379

83807831### Beta Managed Agents Workspace Archived Deployment Paused Reason Error

83817832

8382- `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }`

7833- `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`

83837834

83847835 The deployment's workspace was archived.

83857836

83867837 - `type: "workspace_archived_error"`

8387

8388 - `"workspace_archived_error"`

83897838

This page’s history 18 edits

22 Oct 2026 +16 −16
21 Oct 2026 +16 −0
16 Oct 2026 +40 −8
14 Oct 2026 +16 −0
9 Oct 2026 +16 −0
1 Oct 2026 +16 −0

The page’s own history →

Where it came from

The captureapi
Upstream pageplatform.claude.com

Around it

Every changethe ledger
That day25 Aug 2026