api-20260921T193708Z / documentation capture

api/beta/dreams/retrieve Changed · +104 / -14 lines

from line 7

77

88**GET** `/v1/dreams/{dream_id}`

99

10Get a Dream

10Get a dream by ID to check its status, output memory store, and token usage.

1111

12Archived dreams are returned too.

13

14See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#track-progress) for how to poll a dream and what each status means.

15

1216## Path parameters

1317

1418- `dream_id: string`

1519

20 The ID of the dream to get (`drm_...`).

21

1622## Headers

1723

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

from line 123

117123

118124- `"anthropic-workspace-id": optional string`

119125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

120130## Returns

121131

122132- `BetaDream object`

123133

124 An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.

134 An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store.

125135

136 By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. The Dreams API is in research preview, so this resource can still change.

137

138 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works) for what a dream reads and produces.

139

126140 - `type: "dream"`

127141

128142 - `id: string`

129143

144 The unique ID of the dream (`drm_...`).

145

130146 - `archived_at: string or null`

131147

132148 A timestamp in RFC 3339 format

from line 167

151167

152168 - `type: string`

153169

170 A code for why the dream failed, such as `timeout` or `internal_error`.

171

172 The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors) lists common error codes and when they occur.

173

154174 - `message: string`

155175

176 A human-readable explanation of why the dream failed.

177

156178 - `inputs: array of BetaDreamInput`

157179

180 The sources that the dream reads, from the request that created it.

181

158182 - `BetaDreamMemoryStoreInput object`

159183

160 An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.

184 The memory store that a dream reads, given as an entry in `inputs`.

161185

186 With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it.

187

162188 - `type: "memory_store"`

163189

164190 - `memory_store_id: string`

165191

192 The ID of the memory store for the dream to read (`memstore_...`).

193

194 The memory store must be in the same workspace as the dream and must not be archived.

195

166196 minLength: 1

167197

168198 - `BetaDreamSessionsInput object`

169199

170 Input session transcripts the dream reads.

200 The sessions that a dream reads, given as an entry in `inputs`.

171201

172202 - `type: "sessions"`

173203

174204 - `session_ids: array of string`

175205

206 The IDs of the sessions whose transcripts the dream reads (`sesn_...`).

207

208 Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order.

209

210 The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits) lists all the limits on a dream.

211

176212 - `instructions: string or null`

177213

214 The guidance given when the dream was created, or `null` if none was given.

215

178216 - `model: BetaDreamModelConfig`

179217

180 Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.

218 The model that runs a dream, from the request that created it.

181219

220 The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID.

221

182222 - `id: string`

183223

184 Model identifier, e.g. "claude-opus-5". 1-256 characters.

224 The ID of the model that runs the dream, as given in the request that created it.

185225

186226 minLength: 1, maxLength: 256

187227

from line 235

195235

196236 - `output_behavior: BetaOutputBehavior`

197237

238 Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request.

239

198240 - `BetaOutputBehaviorCreateNew object`

199241

200 The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated.

242 Write the result to a new memory store that starts as a copy of the input memory store. This is the default.

201243

244 The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store.

245

202246 - `type: "create_new"`

203247

204248 - `BetaOutputBehaviorUpdateExisting object`

205249

206 The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place.

250 Write the result into the input memory store instead of a new memory store.

207251

252 The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error.

253

208254 - `type: "update_existing"`

209255

210256 - `memory_store_id: string`

211257

258 The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`.

259

212260 minLength: 1

213261

214262 - `outputs: array of BetaDreamOutput`

215263

264 The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store.

265

266 The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`.

267

268 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output) for how to review and use the result.

269

216270 - `type: "memory_store"`

217271

218272 - `memory_store_id: string`

219273

274 The ID of the memory store that the dream writes its result to (`memstore_...`).

275

276 With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store.

277

220278 - `session_id: string or null`

221279

280 The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started.

281

282 Stream that session's events to follow what the dream reads and writes.

283

284 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run) for how to watch a running dream.

285

222286 - `status: BetaDreamStatus`

223287

224 Lifecycle status of a Dream.

288 Where a dream is in its lifecycle.

225289

290 `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again.

291

292 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle) for what each status means.

293

226294 - `"pending"`

227295

296 The dream is waiting to start and hasn't read its inputs yet.

297

298 `outputs` is empty and every `usage` count is zero.

299

228300 - `"running"`

229301

302 The dream is reading its inputs and writing its result.

303

304 `usage` updates while the dream has this status.

305

230306 - `"completed"`

231307

308 The dream finished and its output memory store holds the complete result.

309

232310 - `"failed"`

233311

312 The dream stopped with an error, which `error` describes.

313

314 If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped.

315

234316 - `"canceled"`

235317

318 A cancel request stopped the dream before it reached `completed` or `failed`.

319

320 If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel.

321

236322 - `usage: BetaDreamUsage`

237323

238 Cumulative token usage for the dream across every pipeline stage.

324 The tokens that a dream has used so far.

239325

326 The counts are zero while the dream is `pending` and update while it is `running`. They can keep changing after a cancel.

327

328 See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing) for how dreams are billed. See the [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance) for how the input token counts add up.

329

240330 - `cache_creation_input_tokens: number`

241331

242 Total tokens used to create prompt-cache entries (sum of all TTL tiers).

332 The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations.

243333

244334 format: int32

245335

246336 - `cache_read_input_tokens: number`

247337

248 Total tokens read from prompt cache.

338 The dream's input tokens that were read from the prompt cache.

249339

250340 format: int32

251341

252342 - `input_tokens: number`

253343

254 Total uncached input tokens consumed across every pipeline stage.

344 The dream's input tokens that weren't read from or written to the prompt cache.

255345

256346 format: int32

257347

258348 - `output_tokens: number`

259349

260 Total output tokens generated across every pipeline stage.

350 The tokens that the model generated for the dream.

261351

262352 format: int32

263353

api/beta/environments Changed · +40 / -0 lines

from line 115

115115

116116- `"anthropic-workspace-id": optional string`

117117

118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

119

120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

121

118122### Body parameters

119123

120124- `name: string`

from line 582

578582

579583- `"anthropic-workspace-id": optional string`

580584

585 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

586

587 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

588

581589### Returns

582590

583591- `data: array of BetaEnvironment`

from line 901

893901

894902- `"anthropic-workspace-id": optional string`

895903

904 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

905

906 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

907

896908### Returns

897909

898910- `BetaEnvironment object`

from line 1211

11991211

12001212- `"anthropic-workspace-id": optional string`

12011213

1214 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1215

1216 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1217

12021218### Body parameters

12031219

12041220- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`

from line 1647

16311647

16321648- `"anthropic-workspace-id": optional string`

16331649

1650 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1651

1652 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1653

16341654### Returns

16351655

16361656- `BetaEnvironmentDeleteResponse object`

from line 1800

17801800

17811801- `"anthropic-workspace-id": optional string`

17821802

1803 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1804

1805 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1806

17831807### Returns

17841808

17851809- `BetaEnvironment object`

from line 2584

25602584

25612585- `"anthropic-workspace-id": optional string`

25622586

2587 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

2588

2589 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

2590

25632591#### Returns

25642592

25652593- `BetaSelfHostedWork object`

from line 3489

34613489

34623490- `"anthropic-workspace-id": optional string`

34633491

3492 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

3493

3494 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

3495

34643496#### Body parameters

34653497

34663498- `force: optional boolean`

from line 3988

39563988

39573989- `"anthropic-workspace-id": optional string`

39583990

3991 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

3992

3993 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

3994

39593995#### Body parameters

39603996

39613997- `metadata: map[string]`

from line 4233

41974233 - `"compact-2026-09-04"`

41984234

41994235- `"anthropic-workspace-id": optional string`

4236

4237 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

4238

4239 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

42004240

42014241#### Returns

42024242

api/beta/environments/work Changed · +16 / -0 lines

from line 123

123123

124124- `"anthropic-workspace-id": optional string`

125125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

126130### Returns

127131

128132- `BetaSelfHostedWork object`

from line 1028

10241028

10251029- `"anthropic-workspace-id": optional string`

10261030

1031 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1032

1033 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1034

10271035### Body parameters

10281036

10291037- `force: optional boolean`

from line 1527

15191527

15201528- `"anthropic-workspace-id": optional string`

15211529

1530 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1531

1532 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1533

15221534### Body parameters

15231535

15241536- `metadata: map[string]`

from line 1772

17601772 - `"compact-2026-09-04"`

17611773

17621774- `"anthropic-workspace-id": optional string`

1775

1776 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1777

1778 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

17631779

17641780### Returns

17651781

api/beta/files Changed · +20 / -0 lines

from line 115

115115

116116- `"anthropic-workspace-id": optional string`

117117

118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

119

120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

121

118122### Body parameters (form-data)

119123

120124- `file: string`

from line 358

354358

355359- `"anthropic-workspace-id": optional string`

356360

361 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

362

363 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

364

357365### Returns

358366

359367- `data: array of BetaFileMetadata`

from line 580

572580

573581- `"anthropic-workspace-id": optional string`

574582

583 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

584

585 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

586

575587### Example

576588

577589```bash

from line 708

696708

697709- `"anthropic-workspace-id": optional string`

698710

711 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

712

713 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

714

699715### Returns

700716

701717- `BetaFileMetadata object`

from line 918

902918 - `"compact-2026-09-04"`

903919

904920- `"anthropic-workspace-id": optional string`

921

922 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

923

924 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

905925

906926### Returns

907927

api/beta/memory_stores Changed · +155 / -13 lines

from line 115

115115

116116- `"anthropic-workspace-id": optional string`

117117

118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

119

120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

121

118122### Body parameters

119123

120124- `name: string`

from line 347

343347

344348- `"anthropic-workspace-id": optional string`

345349

350 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

351

352 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

353

346354### Returns

347355

348356- `data: optional array of BetaManagedAgentsMemoryStore`

from line 438

430438

431439- `memory_store_id: string`

432440

441 ID of the memory store to retrieve (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`.

442

433443### Headers

434444

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

from line 544

534544

535545- `"anthropic-workspace-id": optional string`

536546

547 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

548

549 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

550

537551### Returns

538552

539553- `BetaManagedAgentsMemoryStore object`

from line 626

612626

613627- `memory_store_id: string`

614628

629 ID of the memory store to update (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`. Updating an archived store returns 400.

630

615631### Headers

616632

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

from line 732

716732

717733- `"anthropic-workspace-id": optional string`

718734

735 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

736

737 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

738

719739### Body parameters

720740

721741- `description: optional string or null`

from line 834

814834

815835- `memory_store_id: string`

816836

837 ID of the memory store to permanently delete (a `memstore_...` identifier). Required. Deletion cascades to all memories and memory versions in the store and cannot be undone.

838

817839### Headers

818840

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

from line 940

918940

919941- `"anthropic-workspace-id": optional string`

920942

943 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

944

945 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

946

921947### Returns

922948

923949- `BetaManagedAgentsDeletedMemoryStore object`

from line 985

959985

960986- `memory_store_id: string`

961987

988 ID of the memory store to archive (a `memstore_...` identifier). Required. Archiving is one-way and idempotent; archived stores cannot be unarchived. Enumerate IDs via `GET /v1/memory_stores`.

989

962990### Headers

963991

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

from line 1091

10631091

10641092- `"anthropic-workspace-id": optional string`

10651093

1094 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1095

1096 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1097

10661098### Returns

10671099

10681100- `BetaManagedAgentsMemoryStore object`

from line 1232

12001232

12011233- `memory_store_id: string`

12021234

1235 The ID of the memory store to create the memory in (`memstore_...`).

1236

12031237#### Query parameters

12041238

12051239- `view: optional BetaManagedAgentsMemoryView`

12061240

1207 Query parameter for view

1241 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

12081242

12091243 - `"basic"`

12101244

1245 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

1246

12111247 - `"full"`

12121248

1249 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

1250

12131251#### Headers

12141252

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

from line 1352

13141352

13151353- `"anthropic-workspace-id": optional string`

13161354

1355 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1356

1357 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1358

13171359#### Body parameters

13181360

13191361- `content: string or null`

from line 1459

14171459

14181460- `memory_store_id: string`

14191461

1462 The ID of the memory store to list memories from (`memstore_...`).

1463

14201464#### Query parameters

14211465

14221466- `depth: optional number`

from line 1489

14451489

14461490 - `"basic"`

14471491

1492 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

1493

14481494 - `"full"`

14491495

1496 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

1497

14501498#### Headers

14511499

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

from line 1599

15511599

15521600- `"anthropic-workspace-id": optional string`

15531601

1602 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1603

1604 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1605

15541606#### Returns

15551607

15561608- `data: optional array of BetaManagedAgentsMemoryListItem`

from line 1712

16601712

16611713- `memory_store_id: string`

16621714

1715 The ID of the memory store that holds the memory (`memstore_...`).

1716

16631717- `memory_id: string`

16641718

1719 The ID of the memory to retrieve (`mem_...`).

1720

16651721#### Query parameters

16661722

16671723- `view: optional BetaManagedAgentsMemoryView`

16681724

1669 Query parameter for view

1725 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

16701726

16711727 - `"basic"`

16721728

1729 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

1730

16731731 - `"full"`

16741732

1733 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

1734

16751735#### Headers

16761736

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

from line 1836

17761836

17771837- `"anthropic-workspace-id": optional string`

17781838

1839 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1840

1841 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1842

17791843#### Returns

17801844

17811845- `BetaManagedAgentsMemory object`

from line 1926

18621926

18631927- `memory_store_id: string`

18641928

1929 The ID of the memory store that holds the memory (`memstore_...`).

1930

18651931- `memory_id: string`

18661932

1933 The ID of the memory to update (`mem_...`).

1934

18671935#### Query parameters

18681936

18691937- `view: optional BetaManagedAgentsMemoryView`

18701938

1871 Query parameter for view

1939 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

18721940

18731941 - `"basic"`

18741942

1943 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

1944

18751945 - `"full"`

18761946

1947 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

1948

18771949#### Headers

18781950

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

from line 2050

19782050

19792051- `"anthropic-workspace-id": optional string`

19802052

2053 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

2054

2055 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

2056

19812057#### Body parameters

19822058

19832059- `content: optional string or null`

from line 2164

20882164

20892165- `memory_store_id: string`

20902166

2167 The ID of the memory store that holds the memory (`memstore_...`).

2168

20912169- `memory_id: string`

20922170

2171 The ID of the memory to delete (`mem_...`).

2172

20932173#### Query parameters

20942174

20952175- `expected_content_sha256: optional string`

20962176

2097 Query parameter for expected_content_sha256

2177 Delete the memory only if its current `content_sha256` equals this value, given as 64 lowercase hexadecimal characters. Omit it to delete unconditionally.

20982178

2179 If the hashes differ, the request fails with HTTP status 409 and nothing is deleted.

2180

20992181#### Headers

21002182

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

from line 2282

22002282

22012283- `"anthropic-workspace-id": optional string`

22022284

2285 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

2286

2287 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

2288

22032289#### Returns

22042290

22052291- `BetaManagedAgentsDeletedMemory object`

from line 2329

22432329

22442330- `memory_store_id: string`

22452331

2332 The ID of the memory store whose version history to list (`memstore_...`).

2333

22462334#### Query parameters

22472335

22482336- `api_key_id: optional string`

22492337

2250 Query parameter for api_key_id

2338 Return only versions written with the API key that has this ID.

22512339

22522340- `"created_at[gte]": optional string`

22532341

from line 2351

22632351

22642352- `limit: optional number`

22652353

2266 Query parameter for limit

2354 The maximum number of versions to return per page. Defaults to 20.

22672355

22682356 format: int32

22692357

22702358- `memory_id: optional string`

22712359

2272 Query parameter for memory_id

2360 Return only versions of the memory with this ID (`mem_...`).

22732361

2362 The filter still works after the memory is deleted. The results then include the version whose `operation` is `deleted`.

2363

22742364- `operation: optional BetaManagedAgentsMemoryVersionOperation`

22752365

2276 Query parameter for operation

2366 Return only versions that record this kind of change.

22772367

22782368 - `"created"`

22792369

2370 The memory was created. The first version in any memory's lineage.

2371

22802372 - `"modified"`

22812373

2374 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

2375

22822376 - `"deleted"`

22832377

2378 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

2379

22842380- `page: optional string`

22852381

2286 Query parameter for page

2382 The `next_page` value from a previous response, to get the next page. Omit it to get the first page.

22872383

22882384- `service_account_id: optional string`

22892385

2290 Query parameter for service_account_id

2386 Return only versions written by the service account with this ID (`svac_...`).

22912387

22922388- `session_id: optional string`

22932389

2294 Query parameter for session_id

2390 Return only versions written by the session with this ID.

22952391

22962392- `view: optional BetaManagedAgentsMemoryView`

22972393

2298 Query parameter for view

2394 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

22992395

23002396 - `"basic"`

23012397

2398 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

2399

23022400 - `"full"`

23032401

2402 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

2403

23042404#### Headers

23052405

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

from line 2505

24052505

24062506- `"anthropic-workspace-id": optional string`

24072507

2508 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

2509

2510 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

2511

24082512#### Returns

24092513

24102514- `data: optional array of BetaManagedAgentsMemoryVersion`

from line 2541

24372541

24382542 - `"created"`

24392543

2544 The memory was created. The first version in any memory's lineage.

2545

24402546 - `"modified"`

24412547

2548 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

2549

24422550 - `"deleted"`

24432551

2552 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

2553

24442554 - `content: optional string or null`

24452555

24462556 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 2685

25752685

25762686- `memory_store_id: string`

25772687

2688 The ID of the memory store that holds the version (`memstore_...`).

2689

25782690- `memory_version_id: string`

25792691

2692 The ID of the memory version to retrieve (`memver_...`).

2693

25802694#### Query parameters

25812695

25822696- `view: optional BetaManagedAgentsMemoryView`

25832697

2584 Query parameter for view

2698 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

25852699

25862700 - `"basic"`

25872701

2702 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

2703

25882704 - `"full"`

25892705

2706 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

2707

25902708#### Headers

25912709

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

from line 2809

26912809

26922810- `"anthropic-workspace-id": optional string`

26932811

2812 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

2813

2814 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

2815

26942816#### Returns

26952817

26962818- `BetaManagedAgentsMemoryVersion object`

from line 2845

27232845

27242846 - `"created"`

27252847

2848 The memory was created. The first version in any memory's lineage.

2849

27262850 - `"modified"`

27272851

2852 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

2853

27282854 - `"deleted"`

27292855

2856 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

2857

27302858 - `content: optional string or null`

27312859

27322860 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 2980

28522980

28532981- `memory_store_id: string`

28542982

2983 The ID of the memory store that holds the version (`memstore_...`).

2984

28552985- `memory_version_id: string`

28562986

2987 The ID of the memory version to redact (`memver_...`).

2988

28572989#### Headers

28582990

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

from line 3090

29583090

29593091- `"anthropic-workspace-id": optional string`

29603092

3093 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

3094

3095 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

3096

29613097#### Returns

29623098

29633099- `BetaManagedAgentsMemoryVersion object`

from line 3126

29903126

29913127 - `"created"`

29923128

3129 The memory was created. The first version in any memory's lineage.

3130

29933131 - `"modified"`

29943132

3133 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

3134

29953135 - `"deleted"`

3136

3137 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

29963138

29973139 - `content: optional string or null`

29983140

api/beta/memory_stores/archive Changed · +6 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 ID of the memory store to archive (a `memstore_...` identifier). Required. Archiving is one-way and idempotent; archived stores cannot be unarchived. Enumerate IDs via `GET /v1/memory_stores`.

17

1618## Headers

1719

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

from line 118

116118 - `"compact-2026-09-04"`

117119

118120- `"anthropic-workspace-id": optional string`

121

122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

123

124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

119125

120126## Returns

121127

api/beta/memory_stores/delete Changed · +6 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 ID of the memory store to permanently delete (a `memstore_...` identifier). Required. Deletion cascades to all memories and memory versions in the store and cannot be undone.

17

1618## Headers

1719

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

from line 118

116118 - `"compact-2026-09-04"`

117119

118120- `"anthropic-workspace-id": optional string`

121

122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

123

124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

119125

120126## Returns

121127

api/beta/memory_stores/memories Changed · +102 / -4 lines

from line 15

1515

1616- `memory_store_id: string`

1717

18 The ID of the memory store to create the memory in (`memstore_...`).

19

1820### Query parameters

1921

2022- `view: optional BetaManagedAgentsMemoryView`

2123

22 Query parameter for view

24 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

2325

2426 - `"basic"`

2527

28 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

29

2630 - `"full"`

2731

32 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

33

2834### Headers

2935

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

from line 135

129135

130136- `"anthropic-workspace-id": optional string`

131137

138 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

139

140 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

141

132142### Body parameters

133143

134144- `content: string or null`

from line 242

232242

233243- `memory_store_id: string`

234244

245 The ID of the memory store to list memories from (`memstore_...`).

246

235247### Query parameters

236248

237249- `depth: optional number`

from line 272

260272

261273 - `"basic"`

262274

275 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

276

263277 - `"full"`

264278

279 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

280

265281### Headers

266282

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

from line 382

366382

367383- `"anthropic-workspace-id": optional string`

368384

385 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

386

387 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

388

369389### Returns

370390

371391- `data: optional array of BetaManagedAgentsMemoryListItem`

from line 495

475495

476496- `memory_store_id: string`

477497

498 The ID of the memory store that holds the memory (`memstore_...`).

499

478500- `memory_id: string`

479501

502 The ID of the memory to retrieve (`mem_...`).

503

480504### Query parameters

481505

482506- `view: optional BetaManagedAgentsMemoryView`

483507

484 Query parameter for view

508 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

485509

486510 - `"basic"`

487511

512 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

513

488514 - `"full"`

489515

516 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

517

490518### Headers

491519

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

from line 619

591619

592620- `"anthropic-workspace-id": optional string`

593621

622 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

623

624 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

625

594626### Returns

595627

596628- `BetaManagedAgentsMemory object`

from line 709

677709

678710- `memory_store_id: string`

679711

712 The ID of the memory store that holds the memory (`memstore_...`).

713

680714- `memory_id: string`

681715

716 The ID of the memory to update (`mem_...`).

717

682718### Query parameters

683719

684720- `view: optional BetaManagedAgentsMemoryView`

685721

686 Query parameter for view

722 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

687723

688724 - `"basic"`

689725

726 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

727

690728 - `"full"`

691729

730 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

731

692732### Headers

693733

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

from line 833

793833

794834- `"anthropic-workspace-id": optional string`

795835

836 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

837

838 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

839

796840### Body parameters

797841

798842- `content: optional string or null`

from line 947

903947

904948- `memory_store_id: string`

905949

950 The ID of the memory store that holds the memory (`memstore_...`).

951

906952- `memory_id: string`

907953

954 The ID of the memory to delete (`mem_...`).

955

908956### Query parameters

909957

910958- `expected_content_sha256: optional string`

911959

912 Query parameter for expected_content_sha256

960 Delete the memory only if its current `content_sha256` equals this value, given as 64 lowercase hexadecimal characters. Omit it to delete unconditionally.

913961

962 If the hashes differ, the request fails with HTTP status 409 and nothing is deleted.

963

914964### Headers

915965

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

from line 1065

10151065

10161066- `"anthropic-workspace-id": optional string`

10171067

1068 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

1069

1070 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

1071

10181072### Returns

10191073

10201074- `BetaManagedAgentsDeletedMemory object`

from line 1230

11761230

11771231 - `BetaManagedAgentsMemoryPreconditionFailedError object`

11781232

1233 The error returned with HTTP status 409 when a request's precondition doesn't hold for the memory's current state, such as `precondition` on an update or `expected_content_sha256` on a delete.

1234

1235 The error doesn't include the memory's current state. Retrieve the memory to see its current content and `content_sha256` before you retry.

1236

1237 See the [memory guide](https://platform.claude.com/docs/en/managed-agents/memory#safe-content-edits-optimistic-concurrency) to learn more about safe content edits with content hash preconditions.

1238

11791239 - `type: "memory_precondition_failed_error"`

11801240

11811241 - `message: optional string`

11821242

1243 A human-readable explanation of why the precondition failed.

1244

11831245 - `BetaManagedAgentsMemoryPathConflictError object`

11841246

1247 The error returned with HTTP status 409 when a create or rename targets a path that another memory uses, or a path that overlaps another memory's path.

1248

1249 Two paths overlap when one is an ancestor of the other, such as `/notes` and `/notes/todo.md`. To free the path, rename or delete the memory that `conflicting_memory_id` references, then retry. To change that memory instead of creating a new one, update it.

1250

11851251 - `type: "memory_path_conflict_error"`

11861252

11871253 - `conflicting_memory_id: optional string`

11881254

1255 The ID of the memory that blocked the write (`mem_...`), or an empty string if that memory can't be identified.

1256

1257 Retry the request when it is empty.

1258

11891259 - `conflicting_path: optional string`

11901260

1261 The path that blocked the write: the requested path, or the path of a memory that is an ancestor or descendant of it.

1262

11911263 - `message: optional string`

11921264

1265 A human-readable explanation of the conflict. To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead.

1266

11931267 - `BetaManagedAgentsConflictError object`

11941268

11951269 - `type: "conflict_error"`

from line 1388

13141388

13151389- `BetaManagedAgentsMemoryPathConflictError object`

13161390

1391 The error returned with HTTP status 409 when a create or rename targets a path that another memory uses, or a path that overlaps another memory's path.

1392

1393 Two paths overlap when one is an ancestor of the other, such as `/notes` and `/notes/todo.md`. To free the path, rename or delete the memory that `conflicting_memory_id` references, then retry. To change that memory instead of creating a new one, update it.

1394

13171395 - `type: "memory_path_conflict_error"`

13181396

13191397 - `conflicting_memory_id: optional string`

13201398

1399 The ID of the memory that blocked the write (`mem_...`), or an empty string if that memory can't be identified.

1400

1401 Retry the request when it is empty.

1402

13211403 - `conflicting_path: optional string`

13221404

1405 The path that blocked the write: the requested path, or the path of a memory that is an ancestor or descendant of it.

1406

13231407 - `message: optional string`

13241408

1409 A human-readable explanation of the conflict. To handle the error in code, use `conflicting_path` and `conflicting_memory_id` instead.

1410

13251411### Beta Managed Agents Memory Precondition Failed Error

13261412

13271413- `BetaManagedAgentsMemoryPreconditionFailedError object`

13281414

1415 The error returned with HTTP status 409 when a request's precondition doesn't hold for the memory's current state, such as `precondition` on an update or `expected_content_sha256` on a delete.

1416

1417 The error doesn't include the memory's current state. Retrieve the memory to see its current content and `content_sha256` before you retry.

1418

1419 See the [memory guide](https://platform.claude.com/docs/en/managed-agents/memory#safe-content-edits-optimistic-concurrency) to learn more about safe content edits with content hash preconditions.

1420

13291421 - `type: "memory_precondition_failed_error"`

13301422

13311423 - `message: optional string`

13321424

1425 A human-readable explanation of why the precondition failed.

1426

13331427### Beta Managed Agents Memory Prefix

13341428

13351429- `BetaManagedAgentsMemoryPrefix object`

from line 1444

13501444

13511445 - `"basic"`

13521446

1447 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

1448

13531449 - `"full"`

1450

1451 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

13541452

13551453### Beta Managed Agents Precondition

13561454

api/beta/memory_stores/memories/create Changed · +11 / -1 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store to create the memory in (`memstore_...`).

17

1618## Query parameters

1719

1820- `view: optional BetaManagedAgentsMemoryView`

1921

20 Query parameter for view

22 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

2123

2224 - `"basic"`

2325

26 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

27

2428 - `"full"`

2529

30 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

31

2632## Headers

2733

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

from line 132

126132 - `"compact-2026-09-04"`

127133

128134- `"anthropic-workspace-id": optional string`

135

136 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

137

138 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129139

130140## Body parameters

131141

api/beta/memory_stores/memories/delete Changed · +11 / -1 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store that holds the memory (`memstore_...`).

17

1618- `memory_id: string`

1719

20 The ID of the memory to delete (`mem_...`).

21

1822## Query parameters

1923

2024- `expected_content_sha256: optional string`

2125

22 Query parameter for expected_content_sha256

26 Delete the memory only if its current `content_sha256` equals this value, given as 64 lowercase hexadecimal characters. Omit it to delete unconditionally.

2327

28 If the hashes differ, the request fails with HTTP status 409 and nothing is deleted.

29

2430## Headers

2531

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

from line 130

124130 - `"compact-2026-09-04"`

125131

126132- `"anthropic-workspace-id": optional string`

133

134 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

135

136 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

127137

128138## Returns

129139

api/beta/memory_stores/memories/list Changed · +10 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store to list memories from (`memstore_...`).

17

1618## Query parameters

1719

1820- `depth: optional number`

from line 43

4143

4244 - `"basic"`

4345

46 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

47

4448 - `"full"`

4549

50 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

51

4652## Headers

4753

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

from line 152

146152 - `"compact-2026-09-04"`

147153

148154- `"anthropic-workspace-id": optional string`

155

156 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

157

158 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

149159

150160## Returns

151161

api/beta/memory_stores/memories/retrieve Changed · +13 / -1 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store that holds the memory (`memstore_...`).

17

1618- `memory_id: string`

1719

20 The ID of the memory to retrieve (`mem_...`).

21

1822## Query parameters

1923

2024- `view: optional BetaManagedAgentsMemoryView`

2125

22 Query parameter for view

26 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

2327

2428 - `"basic"`

2529

30 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

31

2632 - `"full"`

2733

34 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

35

2836## Headers

2937

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

from line 136

128136 - `"compact-2026-09-04"`

129137

130138- `"anthropic-workspace-id": optional string`

139

140 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

141

142 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

131143

132144## Returns

133145

api/beta/memory_stores/memories/update Changed · +13 / -1 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store that holds the memory (`memstore_...`).

17

1618- `memory_id: string`

1719

20 The ID of the memory to update (`mem_...`).

21

1822## Query parameters

1923

2024- `view: optional BetaManagedAgentsMemoryView`

2125

22 Query parameter for view

26 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

2327

2428 - `"basic"`

2529

30 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

31

2632 - `"full"`

2733

34 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

35

2836## Headers

2937

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

from line 136

128136 - `"compact-2026-09-04"`

129137

130138- `"anthropic-workspace-id": optional string`

139

140 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

141

142 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

131143

132144## Body parameters

133145

api/beta/memory_stores/memory_versions Changed · +77 / -9 lines

from line 15

1515

1616- `memory_store_id: string`

1717

18 The ID of the memory store whose version history to list (`memstore_...`).

19

1820### Query parameters

1921

2022- `api_key_id: optional string`

2123

22 Query parameter for api_key_id

24 Return only versions written with the API key that has this ID.

2325

2426- `"created_at[gte]": optional string`

2527

from line 37

3537

3638- `limit: optional number`

3739

38 Query parameter for limit

40 The maximum number of versions to return per page. Defaults to 20.

3941

4042 format: int32

4143

4244- `memory_id: optional string`

4345

44 Query parameter for memory_id

46 Return only versions of the memory with this ID (`mem_...`).

4547

48 The filter still works after the memory is deleted. The results then include the version whose `operation` is `deleted`.

49

4650- `operation: optional BetaManagedAgentsMemoryVersionOperation`

4751

48 Query parameter for operation

52 Return only versions that record this kind of change.

4953

5054 - `"created"`

5155

56 The memory was created. The first version in any memory's lineage.

57

5258 - `"modified"`

5359

60 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

61

5462 - `"deleted"`

5563

64 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

65

5666- `page: optional string`

5767

58 Query parameter for page

68 The `next_page` value from a previous response, to get the next page. Omit it to get the first page.

5969

6070- `service_account_id: optional string`

6171

62 Query parameter for service_account_id

72 Return only versions written by the service account with this ID (`svac_...`).

6373

6474- `session_id: optional string`

6575

66 Query parameter for session_id

76 Return only versions written by the session with this ID.

6777

6878- `view: optional BetaManagedAgentsMemoryView`

6979

70 Query parameter for view

80 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

7181

7282 - `"basic"`

7383

84 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

85

7486 - `"full"`

7587

88 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

89

7690### Headers

7791

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

from line 191

177191

178192- `"anthropic-workspace-id": optional string`

179193

194 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

195

196 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

197

180198### Returns

181199

182200- `data: optional array of BetaManagedAgentsMemoryVersion`

from line 227

209227

210228 - `"created"`

211229

230 The memory was created. The first version in any memory's lineage.

231

212232 - `"modified"`

213233

234 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

235

214236 - `"deleted"`

215237

238 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

239

216240 - `content: optional string or null`

217241

218242 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 371

347371

348372- `memory_store_id: string`

349373

374 The ID of the memory store that holds the version (`memstore_...`).

375

350376- `memory_version_id: string`

351377

378 The ID of the memory version to retrieve (`memver_...`).

379

352380### Query parameters

353381

354382- `view: optional BetaManagedAgentsMemoryView`

355383

356 Query parameter for view

384 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

357385

358386 - `"basic"`

359387

388 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

389

360390 - `"full"`

361391

392 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

393

362394### Headers

363395

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

from line 495

463495

464496- `"anthropic-workspace-id": optional string`

465497

498 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

499

500 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

501

466502### Returns

467503

468504- `BetaManagedAgentsMemoryVersion object`

from line 531

495531

496532 - `"created"`

497533

534 The memory was created. The first version in any memory's lineage.

535

498536 - `"modified"`

499537

538 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

539

500540 - `"deleted"`

501541

542 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

543

502544 - `content: optional string or null`

503545

504546 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 666

624666

625667- `memory_store_id: string`

626668

669 The ID of the memory store that holds the version (`memstore_...`).

670

627671- `memory_version_id: string`

628672

673 The ID of the memory version to redact (`memver_...`).

674

629675### Headers

630676

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

from line 776

730776

731777- `"anthropic-workspace-id": optional string`

732778

779 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

780

781 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

782

733783### Returns

734784

735785- `BetaManagedAgentsMemoryVersion object`

from line 812

762812

763813 - `"created"`

764814

815 The memory was created. The first version in any memory's lineage.

816

765817 - `"modified"`

766818

819 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

820

767821 - `"deleted"`

768822

823 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

824

769825 - `content: optional string or null`

770826

771827 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 1040

9841040

9851041 - `"created"`

9861042

1043 The memory was created. The first version in any memory's lineage.

1044

9871045 - `"modified"`

9881046

1047 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

1048

9891049 - `"deleted"`

9901050

1051 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

1052

9911053 - `content: optional string or null`

9921054

9931055 The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set.

from line 1138

10761138

10771139 - `"created"`

10781140

1141 The memory was created. The first version in any memory's lineage.

1142

10791143 - `"modified"`

10801144

1145 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

1146

10811147 - `"deleted"`

1148

1149 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

10821150

10831151### Beta Managed Agents Service Account Actor

10841152

api/beta/memory_stores/memory_versions/list Changed · +32 / -8 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store whose version history to list (`memstore_...`).

17

1618## Query parameters

1719

1820- `api_key_id: optional string`

1921

20 Query parameter for api_key_id

22 Return only versions written with the API key that has this ID.

2123

2224- `"created_at[gte]": optional string`

2325

from line 35

3335

3436- `limit: optional number`

3537

36 Query parameter for limit

38 The maximum number of versions to return per page. Defaults to 20.

3739

3840 format: int32

3941

4042- `memory_id: optional string`

4143

42 Query parameter for memory_id

44 Return only versions of the memory with this ID (`mem_...`).

4345

46 The filter still works after the memory is deleted. The results then include the version whose `operation` is `deleted`.

47

4448- `operation: optional BetaManagedAgentsMemoryVersionOperation`

4549

46 Query parameter for operation

50 Return only versions that record this kind of change.

4751

4852 - `"created"`

4953

54 The memory was created. The first version in any memory's lineage.

55

5056 - `"modified"`

5157

58 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

59

5260 - `"deleted"`

5361

62 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

63

5464- `page: optional string`

5565

56 Query parameter for page

66 The `next_page` value from a previous response, to get the next page. Omit it to get the first page.

5767

5868- `service_account_id: optional string`

5969

60 Query parameter for service_account_id

70 Return only versions written by the service account with this ID (`svac_...`).

6171

6272- `session_id: optional string`

6373

64 Query parameter for session_id

74 Return only versions written by the session with this ID.

6575

6676- `view: optional BetaManagedAgentsMemoryView`

6777

68 Query parameter for view

78 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

6979

7080 - `"basic"`

7181

82 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

83

7284 - `"full"`

7385

86 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

87

7488## Headers

7589

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

from line 189

175189

176190- `"anthropic-workspace-id": optional string`

177191

192 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

193

194 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

195

178196## Returns

179197

180198- `data: optional array of BetaManagedAgentsMemoryVersion`

from line 225

207225

208226 - `"created"`

209227

228 The memory was created. The first version in any memory's lineage.

229

210230 - `"modified"`

211231

232 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

233

212234 - `"deleted"`

235

236 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

213237

214238 - `content: optional string or null`

215239

api/beta/memory_stores/memory_versions/redact Changed · +14 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store that holds the version (`memstore_...`).

17

1618- `memory_version_id: string`

1719

20 The ID of the memory version to redact (`memver_...`).

21

1822## Headers

1923

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

from line 123

119123

120124- `"anthropic-workspace-id": optional string`

121125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

122130## Returns

123131

124132- `BetaManagedAgentsMemoryVersion object`

from line 159

151159

152160 - `"created"`

153161

162 The memory was created. The first version in any memory's lineage.

163

154164 - `"modified"`

155165

166 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

167

156168 - `"deleted"`

169

170 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

157171

158172 - `content: optional string or null`

159173

api/beta/memory_stores/memory_versions/retrieve Changed · +19 / -1 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 The ID of the memory store that holds the version (`memstore_...`).

17

1618- `memory_version_id: string`

1719

20 The ID of the memory version to retrieve (`memver_...`).

21

1822## Query parameters

1923

2024- `view: optional BetaManagedAgentsMemoryView`

2125

22 Query parameter for view

26 Selects which projection of a `memory` or `memory_version` the server returns. `basic` returns the object with `content` set to `null`; `full` populates `content`. When omitted, the default is endpoint-specific: retrieve operations default to `full`; list, create, and update operations default to `basic`. Listing with `view=full` caps `limit` at 20.

2327

2428 - `"basic"`

2529

30 Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content.

31

2632 - `"full"`

2733

34 Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20.

35

2836## Headers

2937

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

from line 137

129137

130138- `"anthropic-workspace-id": optional string`

131139

140 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

141

142 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

143

132144## Returns

133145

134146- `BetaManagedAgentsMemoryVersion object`

from line 173

161173

162174 - `"created"`

163175

176 The memory was created. The first version in any memory's lineage.

177

164178 - `"modified"`

165179

180 The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`.

181

166182 - `"deleted"`

183

184 The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash.

167185

168186 - `content: optional string or null`

169187

api/beta/memory_stores/retrieve Changed · +6 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 ID of the memory store to retrieve (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`.

17

1618## Headers

1719

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

from line 118

116118 - `"compact-2026-09-04"`

117119

118120- `"anthropic-workspace-id": optional string`

121

122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

123

124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

119125

120126## Returns

121127

api/beta/memory_stores/update Changed · +6 / -0 lines

from line 13

1313

1414- `memory_store_id: string`

1515

16 ID of the memory store to update (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`. Updating an archived store returns 400.

17

1618## Headers

1719

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

from line 118

116118 - `"compact-2026-09-04"`

117119

118120- `"anthropic-workspace-id": optional string`

121

122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

123

124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

119125

120126## Body parameters

121127

api/beta/messages Changed · +44 / -12 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

from line 123

123123

124124- `"anthropic-workspace-id": optional string`

125125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

126130### Body parameters

127131

128132- `max_tokens: number`

from line 5186

51825186

51835187 - `diagnostics: BetaDiagnostics or null`

51845188

5185 Response envelope for request-level diagnostics. Present (possibly

5186 null) whenever the caller supplied `diagnostics` on the request.

5189 Request-level diagnostics: why the prompt cache could not fully reuse

5190 the prefix of the request named by `diagnostics.previous_message_id`.

51875191

51885192 - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null`

51895193

from line 6412

64086412

64096413- `"anthropic-workspace-id": optional string`

64106414

6415 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

6416

6417 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

6418

64116419### Body parameters

64126420

64136421- `messages: array of BetaMessageParam`

from line 8325

83178325

83188326 Name of the tool.

83198327

8320 This is how the tool will be called by the model and in `tool_use` blocks.

8321

8322 - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`

8323

8324 - `"direct"`

8325

8326 - `"code_execution_20250825"`

8327

8328 - `"code_execution_20260120"`

8329

8330 - `"code_execution_20260521"`

8331

8332 - `cache_control: optional BetaCacheControlEphemeral or null`

8333

8334 Create a cache control breakpoint at this content block.

8335

8336 - `defer_loading: optional boolean`

8337

8338 If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference

8328

api/beta/messages/batches Changed · +32 / -8 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

from line 123

123123

124124- `"anthropic-workspace-id": optional string`

125125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

126130### Body parameters

127131

128132- `requests: array of object`

from line 4387

43834387

43844388- `"anthropic-workspace-id": optional string`

43854389

4390 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

4391

4392 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

4393

43864394### Returns

43874395

43884396- `BetaMessageBatch object`

from line 4663

46554663

46564664- `"anthropic-workspace-id": optional string`

46574665

4666 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

4667

4668 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

4669

46584670### Returns

46594671

46604672- `data: array of BetaMessageBatch`

from line 4948

49364948

49374949- `"anthropic-workspace-id": optional string`

49384950

4951 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

4952

4953 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

4954

49394955### Returns

49404956

49414957- `BetaMessageBatch object`

from line 5215

51995215

52005216- `"anthropic-workspace-id": optional string`

52015217

5218 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

5219

5220 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

5221

52025222### Returns

52035223

52045224- `BetaDeletedMessageBatch object`

from line 5374

53545374

53555375- `"anthropic-workspace-id": optional string`

53565376

5377 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

5378

5379 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

5380

53575381### Returns

53585382

53595383- `BetaMessageBatchIndividualResponse object`

from line 6497

64736497

64746498 - `diagnostics: BetaDiagnostics or null`

64756499

6476 Response envelope for request-level diagnostics. Present (possibly

6477 null) whenever the caller supplied `diagnostics` on the request.

6500 Request-level diagnostics: why the prompt cache could not fully reuse

6501 the prefix of the request named by `diagnostics.previous_message_id`.

64786502

64796503 - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null`

64806504

from line 8256

82328256

82338257 - `tool_use_id: string`

82348258

8235 pattern: ^srvtoolu_[a-zA-Z0-9_]+$

8236

8237 - `BetaTextEditorCodeExecutionToolResultBlock object`

8238

8239 - `type: "text_editor_code_execution_tool_result"`

8240

8241 default: text_editor_code_execution_tool_result

8242

8243 - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock`

8244

8245 - `BetaTextEditorCodeExecutionToolResultError object`

8246

8247 - `type: "text_editor_code_execution_tool_result_error"`

8248

8249 default: text_editor_code_execution_tool_result_error

8250

8251 - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more`

8252

8253 - `"invalid_tool_input"`

8254

8255 - `"unavailable"`

8256

8257 - `"too_many_requests"`

8258

8259 - `"execution_time_exceeded"`

8260

8261 - `"file_not_found"`

8262

8263 - `error_message: string or null`

8264

8265 - `BetaTextEditorCodeExecutionViewResultBlock object`

8266

8267 - `type: "text_editor_code_execution_view_result"`

8268

8269 default: text_editor_code_execution_view_result

8270

8271 - `content: string`

8272

8273 - `file_type: "text" or "image" or "pdf"`

8274

8275 - `"text"`

8276

8277 - `"image"`

8278

8279 - `"pdf"`

8280

8281 - `num_lines: number or null`

8282

8283 - `start_line: number or null`

8284

8285 - `total_lines: number or null`

8286

8287 - `BetaTextEditorCodeExecutionCreateResultBlock object`

8288

8289 - `type: "text_editor_code_execution_create_result"`

8290

8291 default: text_editor_code_execution_create_result

8292

8293 - `is_file_update: boolean`

8294

8295 - `BetaTextEditorCodeExecutionStrReplaceResultBlock object`

8296

8297

8259 patt

api/beta/messages/batches/results Changed · +6 / -2 lines

from line 123

123123

124124- `"anthropic-workspace-id": optional string`

125125

126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

127

128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

129

126130## Returns

127131

128132- `BetaMessageBatchIndividualResponse object`

from line 1246

12421246

12431247 - `diagnostics: BetaDiagnostics or null`

12441248

1245 Response envelope for request-level diagnostics. Present (possibly

1246 null) whenever the caller supplied `diagnostics` on the request.

1249 Request-level diagnostics: why the prompt cache could not fully reuse

1250 the prefix of the request named by `diagnostics.previous_message_id`.

12471251

12481252 - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null`

12491253

api/beta/messages/create Changed · +6 / -2 lines

from line 121

121121

122122- `"anthropic-workspace-id": optional string`

123123

124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

125

126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

127

124128## Body parameters

125129

126130- `max_tokens: number`

from line 5184

51805184

51815185 - `diagnostics: BetaDiagnostics or null`

51825186

5183 Response envelope for request-level diagnostics. Present (possibly

5184 null) whenever the caller supplied `diagnostics` on the request.

5187 Request-level diagnostics: why the prompt cache could not fully reuse

5188 the prefix of the request named by `diagnostics.previous_message_id`.

51855189

51865190 - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more or null`

51875191

api/beta/models Changed · +8 / -0 lines

from line 135

135135

136136- `"anthropic-workspace-id": optional string`

137137

138 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

139

140 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

141

138142### Returns

139143

140144- `data: array of BetaModelInfo`

from line 518

514518 - `"compact-2026-09-04"`

515519

516520- `"anthropic-workspace-id": optional string`

521

522 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

523

524 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

517525

518526### Returns

519527

api/beta/organization Changed · +377 / -146 lines

This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.

from line 9012

90129012

90139013 default: workspace_rate_limit

90149014

9015 - `group_type: "batch" or "files" or "model_group" or 3 more`

9015 - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more`

90169016

9017 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.

9017 The rate-limit group this entry's limits apply to. Its `type` equals `group_type`.

90189018

9019 - `"batch"`

9019 - `BetaOrganizationRateLimitModelGroup object`

90209020

9021 - `"files"`

9021 - `type: "model_group"`

90229022

9023 - `"model_group"`

9023 Always `model_group`: a family of models.

90249024

9025 - `"skills"`

9025 default: model_group

90269026

9027 - `"token_count"`

9027 - `id: string`

90289028

9029 - `"web_search"`

9029 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

90309030

9031 - `display_name: string`

9032

9033 Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change.

9034

9035 - `BetaOrganizationRateLimitBatchGroup object`

9036

9037 - `type: "batch"`

9038

9039 Always `batch`: the Message Batches API.

9040

9041 default: batch

9042

9043 - `id: string`

9044

9045 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

9046

9047 - `BetaOrganizationRateLimitTokenCountGroup object`

9048

9049 - `type: "token_count"`

9050

9051 Always `token_count`: the Token Count API.

9052

9053 default: token_count

9054

9055 - `id: string`

9056

9057 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

9058

9059 - `BetaOrganizationRateLimitFilesGroup object`

9060

9061 - `type: "files"`

9062

9063 Always `files`: the Files API.

9064

9065 default: files

9066

9067 - `id: string`

9068

9069 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

9070

9071 - `BetaOrganizationRateLimitSkillsGroup object`

9072

9073 - `type: "skills"`

9074

9075 Always `skills`: the Skills API.

9076

9077 default: skills

9078

9079 - `id: string`

9080

9081 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

9082

9083 - `BetaOrganizationRateLimitWebSearchGroup object`

9084

9085 - `type: "web_search"`

9086

9087 Always `web_search`: the Messages API web search tool.

9088

9089 default: web_search

9090

9091 - `id: string`

9092

9093 Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization.

9094

90319095 - `limits: array of BetaWorkspaceRateLimitValue`

90329096

90339097 The limiter values overridden for this group in this workspace. Limiter types without a workspace override are omitted and inherit the organization value.

from line 9114

90509114

90519115 - `rate_limit_id: string`

90529116

9053 The `id` of the RateLimit group this override applies to.

9117 The `id` of the organization's RateLimit entry this override applies to.

90549118

90559119 - `workspace_id: string`

90569120

90579121 ID of the Workspace this override applies to.

90589122

9123 - `group_type: "batch" or "files" or "model_group" or 3 more`

9124

9125 **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`.

9126

9127 Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`.

9128

9129 - `"batch"`

9130

9131 - `"files"`

9132

9133 - `"model_group"`

9134

9135 - `"skills"`

9136

9137 - `"token_count"`

9138

9139 - `"web_search"`

9140

90599141- `next_page: string or null`

90609142

90619143 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.

from line 9156

90749156{

90759157 "data": [

90769158 {

9159 "group": {

9160 "id": "id",

9161 "display_name": "display_name",

9162 "type": "model_group"

9163 },

90779164 "group_type": "batch",

90789165 "limits": [

90799166 {

from line 10540

1045310540```json

1045410541{

1045510542 "service_account_id": "service_account_id",

10456 "type": "service_account_workspace_member_deleted",

10457 "workspace_id": "workspace_id"

10458}

10459```

10460

10461## Organization › Rate Limits

10462

10463### List Organization Rate Limits

10464

10465**GET** `/v1/organizations/rate_limits`

10466

10467List Messages API rate limits for your organization.

10468

10469Each entry corresponds to one rate-limit group (either a model family

10470or an API-surface category such as the Files API or Message Batches)

10471and contains the set of limiter values that apply to it.

10472

10473When `limit` is omitted, every matching entry is returned in a single

10474page; when `limit` truncates the result, follow `next_page` to fetch

10475the remaining entries.

10476

10477#### Query parameters

10478

10479- `group_type: optional "batch" or "files" or "model_group" or 3 more`

10480

10481 Filter by group type.

10482

10483 - `"batch"`

10484

10485 - `"files"`

10486

10487 - `"model_group"`

10488

10489 - `"skills"`

10490

10491 - `"token_count"`

10492

10493 - `"web_search"`

10494

10495- `limit: optional number`

10496

10497 Maximum number of items to return per page. Ranges from `1` to `1000`.

10498

10499 When omitted, every remaining entry is returned in a single page and `next_page` is `null`.

10500

10501 maximum: 1000, minimum: 1

10502

10503- `model: optional string`

10504

10505 Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization.

10506

10507- `page: optional string`

10508

10509 Opaque cursor from a previous response's `next_page`.

10510

10511#### Returns

10512

10513- `data: array of BetaOrganizationRateLimit`

10514

10515 Rate-limit entries for the organization, one per group.

10516

10517 - `type: "rate_limit"`

10518

10519 Object type. Always `rate_limit` for organization rate-limit entries.

10520

10521 default: rate_limit

10522

10523 - `id: string`

10524

10525 Stable identifier for this rate-limit group within the organization.

10526

10527 - `group_type: "batch" or "files" or "model_group" or 3 more`

10528

10529 The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`.

10530

10531 - `"batch"`

10532

10533 - `"files"`

10534

10535 - `"model_group"`

10536

10537 - `"skills"`

10538

10539 - `"token_count"`

10540

10541 - `"web_search"`

10542

10543 - `limits: array of BetaOrganizationRateLimitValue`

10544

10545 The limiter values that apply to this group.

10546

10547 - `type: string`

10548

10549 The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`).

10550

10551 - `value: number`

10552

10553 The configured limit value for this limiter type.

10554

10555 - `models: array of string or null`

10556

10557 Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`.

10558

10559- `next_page: string or null`

10560

10561 Opaque cursor for the next page of results, or `null` when no entries remain beyond this response.

10562

10563#### Example

10564

10565```bash

10566curl https://api.anthropic.com/v1/organizations/rate_limits \

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

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

10569```

10570

10571##### Response (200)

10572

10573```json

10574{

10575 "data": [

10576 {

10577 "id": "id",

10578 "group_type": "batch",

10579 "limits": [

10580 {

10581 "type": "type",

10582 "value": 0

10583 }

10584 ],

10585 "models": [

10586 "string"

10587 ],

10588 "type": "rate_limi

10543

One read of Claude Developer Platform

What this read moved

api/beta/dreams/retrieve Changed · +104 / -14 lines

api/beta/environments Changed · +40 / -0 lines

api/beta/environments/work Changed · +16 / -0 lines

api/beta/files Changed · +20 / -0 lines

api/beta/memory_stores Changed · +155 / -13 lines

api/beta/memory_stores/archive Changed · +6 / -0 lines

api/beta/memory_stores/delete Changed · +6 / -0 lines

api/beta/memory_stores/memories Changed · +102 / -4 lines

api/beta/memory_stores/memories/create Changed · +11 / -1 lines

api/beta/memory_stores/memories/delete Changed · +11 / -1 lines

api/beta/memory_stores/memories/list Changed · +10 / -0 lines

api/beta/memory_stores/memories/retrieve Changed · +13 / -1 lines

api/beta/memory_stores/memories/update Changed · +13 / -1 lines

api/beta/memory_stores/memory_versions Changed · +77 / -9 lines

api/beta/memory_stores/memory_versions/list Changed · +32 / -8 lines

api/beta/memory_stores/memory_versions/redact Changed · +14 / -0 lines

api/beta/memory_stores/memory_versions/retrieve Changed · +19 / -1 lines

api/beta/memory_stores/retrieve Changed · +6 / -0 lines

api/beta/memory_stores/update Changed · +6 / -0 lines

api/beta/messages Changed · +44 / -12 lines

api/beta/messages/batches Changed · +32 / -8 lines

api/beta/messages/batches/results Changed · +6 / -2 lines

api/beta/messages/create Changed · +6 / -2 lines

api/beta/models Changed · +8 / -0 lines

api/beta/organization Changed · +377 / -146 lines