api-20261105T050710Z / page 2 of 7 / documentation capture

api/beta/organization/claude_tag Changed · +4 / -4 lines

from line 689

689689

690690 - `id: string`

691691

692 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

692 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

693693

694694 - `created_at: string`

695695

from line 1089

10891089

10901090 - `id: string`

10911091

1092 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1092 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

10931093

10941094 - `created_at: string`

10951095

from line 1479

14791479

14801480 - `id: string`

14811481

1482 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1482 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

14831483

14841484 - `created_at: string`

14851485

from line 1902

19021902

19031903 - `id: string`

19041904

1905 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1905 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

19061906

19071907 - `created_at: string`

19081908

api/beta/organization/claude_tag/slack_channels Changed · +5 / -5 lines

from line 209

209209

210210 - `id: string`

211211

212 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

212 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

213213

214214 - `created_at: string`

215215

from line 609

609609

610610 - `id: string`

611611

612 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

612 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

613613

614614 - `created_at: string`

615615

from line 999

999999

10001000 - `id: string`

10011001

1002 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1002 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

10031003

10041004 - `created_at: string`

10051005

from line 1422

14221422

14231423 - `id: string`

14241424

1425 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1425 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

14261426

14271427 - `created_at: string`

14281428

from line 1846

18461846

18471847 - `id: string`

18481848

1849 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured gets a new one when claude.ai replaces its record, which happens only while the organization's read-only mode is off. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

1849 The channel's identifier. Starts with `slch_`. It does not change for as long as the channel is set up, with one exception: a channel that is not configured can get a new one. A channel that is removed and set up again also has a new one. The old one keeps returning 404; look the channel up by its Slack identifiers for the new one.

18501850

18511851 - `created_at: string`

18521852

api/beta/organization/rbac_groups Changed · +44 / -40 lines

### Beta Deleted RBAC Group ### RBAC Group Delete Response

from line 429

429429

430430### Returns

431431

432- `type: "rbac_group_deleted"`

432- `BetaDeletedRBACGroup object`

433433

434 Deleted object type.

434 - `type: "rbac_group_deleted"`

435435

436 For RBAC Groups, this is always `"rbac_group_deleted"`.

436 Deleted object type.

437437

438 default: rbac_group_deleted

438 For RBAC Groups, this is always `"rbac_group_deleted"`.

439439

440- `id: string`

440 default: rbac_group_deleted

441441

442 ID of the RBAC Group.

442 - `id: string`

443443

444 ID of the RBAC Group.

445

444446### Example

445447

446448```bash

from line 463

461463

462464## Domain types

463465

466### Beta Deleted RBAC Group

467

468- `BetaDeletedRBACGroup object`

469

470 - `type: "rbac_group_deleted"`

471

472 Deleted object type.

473

474 For RBAC Groups, this is always `"rbac_group_deleted"`.

475

476 default: rbac_group_deleted

477

478 - `id: string`

479

480 ID of the RBAC Group.

481

464482### Beta RBAC Group

465483

466484- `BetaRBACGroup object`

from line 523

505523

506524 format: date-time

507525

508### RBAC Group Delete Response

509

510- `RBACGroupDeleteResponse object`

511

512 - `type: "rbac_group_deleted"`

513

514 Deleted object type.

515

516 For RBAC Groups, this is always `"rbac_group_deleted"`.

517

518 default: rbac_group_deleted

519

520 - `id: string`

521

522 ID of the RBAC Group.

523

524526## RBAC Groups › Members

525527

526528### List RBAC Group Members

from line 735

733735

734736#### Returns

735737

736- `type: "rbac_group_member_deleted"`

738- `BetaDeletedRBACGroupMember object`

737739

738 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

740 - `type: "rbac_group_member_deleted"`

739741

740 default: rbac_group_member_deleted

742 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

741743

742- `rbac_group_id: string`

744 default: rbac_group_member_deleted

743745

744 ID of the RBAC Group.

746 - `rbac_group_id: string`

745747

746- `user_id: string`

748 ID of the RBAC Group.

747749

748 ID of the User.

750 - `user_id: string`

751

752 ID of the User.

749753

750754#### Example

751755

api/beta/organization/rbac_groups/delete Changed · +8 / -6 lines

from line 27

2727

2828## Returns

2929

30- `type: "rbac_group_deleted"`

30- `BetaDeletedRBACGroup object`

3131

32 Deleted object type.

32 - `type: "rbac_group_deleted"`

3333

34 For RBAC Groups, this is always `"rbac_group_deleted"`.

34 Deleted object type.

3535

36 default: rbac_group_deleted

36 For RBAC Groups, this is always `"rbac_group_deleted"`.

3737

38- `id: string`

38 default: rbac_group_deleted

3939

40 ID of the RBAC Group.

40 - `id: string`

41

42 ID of the RBAC Group.

4143

4244## Example

4345

api/beta/organization/rbac_groups/members Changed · +33 / -31 lines

### Beta Deleted RBAC Group Member ### Member Remove Response

from line 215

215215

216216### Returns

217217

218- `type: "rbac_group_member_deleted"`

218- `BetaDeletedRBACGroupMember object`

219219

220 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

220 - `type: "rbac_group_member_deleted"`

221221

222 default: rbac_group_member_deleted

222 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

223223

224- `rbac_group_id: string`

224 default: rbac_group_member_deleted

225225

226 ID of the RBAC Group.

226 - `rbac_group_id: string`

227227

228- `user_id: string`

228 ID of the RBAC Group.

229229

230 ID of the User.

230 - `user_id: string`

231231

232 ID of the User.

233

232234### Example

233235

234236```bash

from line 252

250252

251253## Domain types

252254

255### Beta Deleted RBAC Group Member

256

257- `BetaDeletedRBACGroupMember object`

258

259 - `type: "rbac_group_member_deleted"`

260

261 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

262

263 default: rbac_group_member_deleted

264

265 - `rbac_group_id: string`

266

267 ID of the RBAC Group.

268

269 - `user_id: string`

270

271 ID of the User.

272

253273### Beta RBAC Group Member

254274

255275- `BetaRBACGroupMember object`

from line 291

271291 - `email: string`

272292

273293 Email of the User.

274

275 - `rbac_group_id: string`

276

277 ID of the RBAC Group.

278

279 - `user_id: string`

280

281 ID of the User.

282

283### Member Remove Response

284

285- `MemberRemoveResponse object`

286

287 - `type: "rbac_group_member_deleted"`

288

289 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

290

291 default: rbac_group_member_deleted

292294

293295 - `rbac_group_id: string`

294296

api/beta/organization/rbac_groups/members/remove Changed · +9 / -7 lines

from line 31

3131

3232## Returns

3333

34- `type: "rbac_group_member_deleted"`

34- `BetaDeletedRBACGroupMember object`

3535

36 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

36 - `type: "rbac_group_member_deleted"`

3737

38 default: rbac_group_member_deleted

38 Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`.

3939

40- `rbac_group_id: string`

40 default: rbac_group_member_deleted

4141

42 ID of the RBAC Group.

42 - `rbac_group_id: string`

4343

44- `user_id: string`

44 ID of the RBAC Group.

4545

46 ID of the User.

46 - `user_id: string`

47

48 ID of the User.

4749

4850## Example

4951

api/beta/organization/spend_limits Changed · +26 / -10 lines

from line 1391

13911391

13921392 Opaque cursor from a previous response's `next_page` field.

13931393

1394- `period: optional array of "daily" or "monthly" or "weekly"`

1394- `period: optional array of BetaSpendLimitPeriod`

13951395

13961396 Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for.

13971397

from line 1682

16821682

16831683 - `id: string`

16841684

1685 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1685 - `actor: BetaSpendLimitIncreaseRequestActor`

16861686

1687 Who submitted the increase request.

1688

16871689 - `BetaSpendLimitUserActor object`

16881690

16891691 A user within the organization. `name` and `email_address` are

from line 1742

17401742

17411743 format: date-time

17421744

1743 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

1745 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

17441746

1747 Who approved or denied the increase request.

1748

17451749 - `BetaSpendLimitUserActor object`

17461750

17471751 A user within the organization. `name` and `email_address` are

from line 1995

19911995

19921996 - `id: string`

19931997

1994 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1998 - `actor: BetaSpendLimitIncreaseRequestActor`

19951999

2000 Who submitted the increase request.

2001

19962002 - `BetaSpendLimitUserActor object`

19972003

19982004 A user within the organization. `name` and `email_address` are

from line 2055

20492055

20502056 format: date-time

20512057

2052 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

2058 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

20532059

2060 Who approved or denied the increase request.

2061

20542062 - `BetaSpendLimitUserActor object`

20552063

20562064 A user within the organization. `name` and `email_address` are

from line 2317

23092317

23102318- `id: string`

23112319

2312- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

2320- `actor: BetaSpendLimitIncreaseRequestActor`

23132321

2322 Who submitted the increase request.

2323

23142324 - `BetaSpendLimitUserActor object`

23152325

23162326 A user within the organization. `name` and `email_address` are

from line 2377

23672377

23682378 format: date-time

23692379

2370- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

2380- `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

23712381

2382 Who approved or denied the increase request.

2383

23722384 - `BetaSpendLimitUserActor object`

23732385

23742386 A user within the organization. `name` and `email_address` are

from line 2391

23792391

23802392 A scoped Admin API key acting on behalf of the organization.

23812393

2382- `spend_limit: BetaSpendLimit`

2394- `spend_limit: BetaSpendLimit or null`

23832395

23842396 A configured spend limit: a cap on metered spend for one scope and period.

23852397

from line 2716

27042716

27052717 - `id: string`

27062718

2707 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

2719 - `actor: BetaSpendLimitIncreaseRequestActor`

27082720

2721 Who submitted the increase request.

2722

27092723 - `BetaSpendLimitUserActor object`

27102724

27112725 A user within the organization. `name` and `email_address` are

from line 2776

27622776

27632777 format: date-time

27642778

2765 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

2779 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

2780

2781 Who approved or denied the increase request.

27662782

27672783 - `BetaSpendLimitUserActor object`

27682784

api/beta/organization/spend_limits/increase_requests Changed · +130 / -14 lines

### Beta Spend Limit Increase Request Actor ### Beta Spend Limit Increase Request Resolved By

from line 56

5656

5757 - `id: string`

5858

59 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

59 - `actor: BetaSpendLimitIncreaseRequestActor`

6060

61 Who submitted the increase request.

62

6163 - `BetaSpendLimitUserActor object`

6264

6365 A user within the organization. `name` and `email_address` are

from line 116

114116

115117 format: date-time

116118

117 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

119 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

118120

121 Who approved or denied the increase request.

122

119123 - `BetaSpendLimitUserActor object`

120124

121125 A user within the organization. `name` and `email_address` are

from line 369

365369

366370 - `id: string`

367371

368 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

372 - `actor: BetaSpendLimitIncreaseRequestActor`

369373

374 Who submitted the increase request.

375

370376 - `BetaSpendLimitUserActor object`

371377

372378 A user within the organization. `name` and `email_address` are

from line 429

423429

424430 format: date-time

425431

426 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

432 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

427433

434 Who approved or denied the increase request.

435

428436 - `BetaSpendLimitUserActor object`

429437

430438 A user within the organization. `name` and `email_address` are

from line 691

683691

684692- `id: string`

685693

686- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

694- `actor: BetaSpendLimitIncreaseRequestActor`

687695

696 Who submitted the increase request.

697

688698 - `BetaSpendLimitUserActor object`

689699

690700 A user within the organization. `name` and `email_address` are

from line 751

741751

742752 format: date-time

743753

744- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

754- `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

745755

756 Who approved or denied the increase request.

757

746758 - `BetaSpendLimitUserActor object`

747759

748760 A user within the organization. `name` and `email_address` are

from line 765

753765

754766 A scoped Admin API key acting on behalf of the organization.

755767

756- `spend_limit: BetaSpendLimit`

768- `spend_limit: BetaSpendLimit or null`

757769

758770 A configured spend limit: a cap on metered spend for one scope and period.

759771

from line 1090

10781090

10791091 - `id: string`

10801092

1081 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1093 - `actor: BetaSpendLimitIncreaseRequestActor`

10821094

1095 Who submitted the increase request.

1096

10831097 - `BetaSpendLimitUserActor object`

10841098

10851099 A user within the organization. `name` and `email_address` are

from line 1150

11361150

11371151 format: date-time

11381152

1139 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

1153 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

11401154

1155 Who approved or denied the increase request.

1156

11411157 - `BetaSpendLimitUserActor object`

11421158

11431159 A user within the organization. `name` and `email_address` are

from line 1377

13611377

13621378 - `id: string`

13631379

1364 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1380 - `actor: BetaSpendLimitIncreaseRequestActor`

13651381

1382 Who submitted the increase request.

1383

13661384 - `BetaSpendLimitUserActor object`

13671385

13681386 A user within the organization. `name` and `email_address` are

from line 1437

14191437

14201438 format: date-time

14211439

1422 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

1440 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

14231441

1442 Who approved or denied the increase request.

1443

14241444 - `BetaSpendLimitUserActor object`

14251445

14261446 A user within the organization. `name` and `email_address` are

from line 1593

15731593

15741594 - `"pending"`

15751595

1596### Beta Spend Limit Increase Request Actor

1597

1598- `BetaSpendLimitIncreaseRequestActor = BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1599

1600 Who submitted the increase request.

1601

1602 - `BetaSpendLimitUserActor object`

1603

1604 A user within the organization. `name` and `email_address` are

1605 null when the underlying account is unavailable or has been deleted;

1606 `deleted` is true only for deleted accounts.

1607

1608 - `type: "user_actor"`

1609

1610 Actor type. Always `user_actor`.

1611

1612 default: user_actor

1613

1614 - `deleted: boolean`

1615

1616 True only when the underlying account has been deleted.

1617

1618 default: false

1619

1620 - `email_address: string or null`

1621

1622 The user's email address. Null when the account is unavailable or has been deleted.

1623

1624 - `name: string or null`

1625

1626 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.

1627

1628 - `user_id: string`

1629

1630 Tagged ID of the user.

1631

1632 - `BetaSpendLimitScopedAPIKeyActor object`

1633

1634 A scoped Admin API key acting on behalf of the organization.

1635

1636 - `type: "scoped_api_key_actor"`

1637

1638 default: scoped_api_key_actor

1639

1640 - `scoped_api_key_id: string`

1641

1642### Beta Spend Limit Increase Request Resolved By

1643

1644- `BetaSpendLimitIncreaseRequestResolvedBy = BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1645

1646 Who approved or denied the increase request.

1647

1648 - `BetaSpendLimitUserActor object`

1649

1650 A user within the organization. `name` and `email_address` are

1651 null when the underlying account is unavailable or has been deleted;

1652 `deleted` is true only for deleted accounts.

1653

1654 - `type: "user_actor"`

1655

1656 Actor type. Always `user_actor`.

1657

1658 default: user_actor

1659

1660 - `deleted: boolean`

1661

1662 True only when the underlying account has been deleted.

1663

1664 default: false

1665

1666 - `email_address: string or null`

1667

1668 The user's email address. Null when the account is unavailable or has been deleted.

1669

1670 - `name: string or null`

1671

1672 The user's current display name. Null when the account is unavailable, has been deleted, or has no name set.

1673

1674 - `user_id: string`

1675

1676 Tagged ID of the user.

1677

1678 - `BetaSpendLimitScopedAPIKeyActor object`

1679

1680 A scoped Admin API key acting on behalf of the organization.

1681

1682 - `type: "scoped_api_key_actor"`

1683

1684 default: scoped_api_key_actor

1685

1686 - `scoped_api_key_id: string`

1687

15761688### Beta Spend Limit Increase Request Status

15771689

15781690- `BetaSpendLimitIncreaseRequestStatus = "approved" or "denied" or "pending"`

from line 1705

15931705

15941706 - `id: string`

15951707

1596 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

1708 - `actor: BetaSpendLimitIncreaseRequestActor`

15971709

1710 Who submitted the increase request.

1711

15981712 - `BetaSpendLimitUserActor object`

15991713

16001714 A user within the organization. `name` and `email_address` are

from line 1765

16511765

16521766 format: date-time

16531767

1654 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

1768 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

16551769

1770 Who approved or denied the increase request.

1771

16561772 - `BetaSpendLimitUserActor object`

16571773

16581774 A user within the organization. `name` and `email_address` are

from line 1779

16631779

16641780 A scoped Admin API key acting on behalf of the organization.

16651781

1666 - `spend_limit: BetaSpendLimit`

1782 - `spend_limit: BetaSpendLimit or null`

16671783

16681784 A configured spend limit: a cap on metered spend for one scope and period.

16691785

api/beta/organization/spend_limits/increase_requests/approve Changed · +7 / -3 lines

from line 52

5252

5353- `id: string`

5454

55- `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

55- `actor: BetaSpendLimitIncreaseRequestActor`

5656

57 Who submitted the increase request.

58

5759 - `BetaSpendLimitUserActor object`

5860

5961 A user within the organization. `name` and `email_address` are

from line 112

110112

111113 format: date-time

112114

113- `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

115- `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

114116

117 Who approved or denied the increase request.

118

115119 - `BetaSpendLimitUserActor object`

116120

117121 A user within the organization. `name` and `email_address` are

from line 126

122126

123127 A scoped Admin API key acting on behalf of the organization.

124128

125- `spend_limit: BetaSpendLimit`

129- `spend_limit: BetaSpendLimit or null`

126130

127131 A configured spend limit: a cap on metered spend for one scope and period.

128132

api/beta/organization/spend_limits/increase_requests/deny Changed · +6 / -2 lines

from line 40

4040

4141 - `id: string`

4242

43 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

43 - `actor: BetaSpendLimitIncreaseRequestActor`

4444

45 Who submitted the increase request.

46

4547 - `BetaSpendLimitUserActor object`

4648

4749 A user within the organization. `name` and `email_address` are

from line 100

98100

99101 format: date-time

100102

101 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

103 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

104

105 Who approved or denied the increase request.

102106

103107 - `BetaSpendLimitUserActor object`

104108

api/beta/organization/spend_limits/increase_requests/list Changed · +6 / -2 lines

from line 54

5454

5555 - `id: string`

5656

57 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

57 - `actor: BetaSpendLimitIncreaseRequestActor`

5858

59 Who submitted the increase request.

60

5961 - `BetaSpendLimitUserActor object`

6062

6163 A user within the organization. `name` and `email_address` are

from line 114

112114

113115 format: date-time

114116

115 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

117 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

118

119 Who approved or denied the increase request.

116120

117121 - `BetaSpendLimitUserActor object`

118122

api/beta/organization/spend_limits/increase_requests/retrieve Changed · +6 / -2 lines

from line 36

3636

3737 - `id: string`

3838

39 - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor`

39 - `actor: BetaSpendLimitIncreaseRequestActor`

4040

41 Who submitted the increase request.

42

4143 - `BetaSpendLimitUserActor object`

4244

4345 A user within the organization. `name` and `email_address` are

from line 96

9496

9597 format: date-time

9698

97 - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null`

99 - `resolved_by: BetaSpendLimitIncreaseRequestResolvedBy or null`

100

101 Who approved or denied the increase request.

98102

99103 - `BetaSpendLimitUserActor object`

100104

api/beta/organization/usage_report Changed · +6 / -6 lines

from line 281

281281

282282 - `account_id: string or null`

283283

284 ID of the user account that made the request. `null` if not grouping by account or for non-OAuth requests.

284 ID of the user account that made the request. `null` if not grouping by account or if no user account made the request.

285285

286286 - `api_key_id: string or null`

287287

288 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

288 ID of the API key used. `null` if not grouping by API key or if the request did not use an API key, as with usage in the Claude Console or from most Claude Managed Agents sessions.

289289

290290 - `cache_creation: BetaCacheCreation`

291291

from line 344

344344

345345 - `service_account_id: string or null`

346346

347 ID of the service account that made the request. `null` if not grouping by service account or for non-OIDC-federation requests.

347 ID of the service account that made the request. `null` if not grouping by service account or if no service account made the request. This can be the ID of an Anthropic-managed service account, such as one that runs Claude Managed Agents sessions, which the Service Accounts endpoints do not return.

348348

349349 - `service_tier: BetaAnalyticsServiceTier or null`

350350

from line 891

891891

892892 - `account_id: string or null`

893893

894 ID of the user account that made the request. `null` if not grouping by account or for non-OAuth requests.

894 ID of the user account that made the request. `null` if not grouping by account or if no user account made the request.

895895

896896 - `api_key_id: string or null`

897897

898 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

898 ID of the API key used. `null` if not grouping by API key or if the request did not use an API key, as with usage in the Claude Console or from most Claude Managed Agents sessions.

899899

900900 - `cache_creation: BetaCacheCreation`

901901

from line 954

954954

955955 - `service_account_id: string or null`

956956

957 ID of the service account that made the request. `null` if not grouping by service account or for non-OIDC-federation requests.

957 ID of the service account that made the request. `null` if not grouping by service account or if no service account made the request. This can be the ID of an Anthropic-managed service account, such as one that runs Claude Managed Agents sessions, which the Service Accounts endpoints do not return.

958958

959959 - `service_tier: BetaAnalyticsServiceTier or null`

960960

api/beta/organization/usage_report/retrieve_messages Changed · +3 / -3 lines

from line 279

279279

280280 - `account_id: string or null`

281281

282 ID of the user account that made the request. `null` if not grouping by account or for non-OAuth requests.

282 ID of the user account that made the request. `null` if not grouping by account or if no user account made the request.

283283

284284 - `api_key_id: string or null`

285285

286 ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console.

286 ID of the API key used. `null` if not grouping by API key or if the request did not use an API key, as with usage in the Claude Console or from most Claude Managed Agents sessions.

287287

288288 - `cache_creation: BetaCacheCreation`

289289

from line 342

342342

343343 - `service_account_id: string or null`

344344

345 ID of the service account that made the request. `null` if not grouping by service account or for non-OIDC-federation requests.

345 ID of the service account that made the request. `null` if not grouping by service account or if no service account made the request. This can be the ID of an Anthropic-managed service account, such as one that runs Claude Managed Agents sessions, which the Service Accounts endpoints do not return.

346346

347347 - `service_tier: BetaAnalyticsServiceTier or null`

348348

api/beta/sessions Changed · +342 / -22 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 347

347347

348348 - `speed: optional "standard" or "fast" or null`

349349

350 Inference speed mode. Defaults to `standard`.

350 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.

351351

352352 - `"standard"`

353353

from line 795

795795

796796 Two-letter ISO 3166-1 country code, uppercase.

797797

798 pattern: ^[A-Z]{2}$

799

798800 - `region: optional string or null`

799801

800802 Region or state name.

from line 925

923925

924926 Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.

925927

926 minLength: 1, maxLength: 128

928 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$

927929

928930 - `version: optional number`

929931

from line 953

951953

952954 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

953955

956 pattern: ^(0|[1-9]\d*)$

957

954958 - `currency: BetaCurrency`

955959

956960 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1209

12051209

12061210 Full commit SHA to check out.

12071211

1208 minLength: 7, maxLength: 64

1212 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

12091213

12101214 - `mount_path: optional string or null`

12111215

from line 1245

12411245

12421246 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

12431247

1248 pattern: ^memstore_[a-zA-Z0-9_]+$

1249

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

12451251

12461252 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.

from line 1839

18331839

18341840 Two-letter ISO 3166-1 country code, uppercase.

18351841

1842 pattern: ^[A-Z]{2}$

1843

18361844 - `region: optional string or null`

18371845

18381846 Region or state name.

from line 2149

21412149

21422150 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

21432151

2152 pattern: ^(0|[1-9]\d*)$

2153

21442154 - `currency: BetaCurrency`

21452155

21462156 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 2243

22332243

22342244 Full commit SHA to check out.

22352245

2236 minLength: 7, maxLength: 64

2246 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

22372247

22382248 - `BetaManagedAgentsFileResource object`

22392249

from line 2277

22672277

22682278 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

22692279

2280 pattern: ^memstore_[a-zA-Z0-9_]+$

2281

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

22712283

22722284 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 3435

34233435

34243436 Two-letter ISO 3166-1 country code, uppercase.

34253437

3438 pattern: ^[A-Z]{2}$

3439

34263440 - `region: optional string or null`

34273441

34283442 Region or state name.

from line 3745

37313745

37323746 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

37333747

3748 pattern: ^(0|[1-9]\d*)$

3749

37343750 - `currency: BetaCurrency`

37353751

37363752 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 3839

38233839

38243840 Full commit SHA to check out.

38253841

3826 minLength: 7, maxLength: 64

3842 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

38273843

38283844 - `BetaManagedAgentsFileResource object`

38293845

from line 3873

38573873

38583874 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

38593875

3876 pattern: ^memstore_[a-zA-Z0-9_]+$

3877

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

38613879

38623880 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 4946

49284946

49294947 Two-letter ISO 3166-1 country code, uppercase.

49304948

4949 pattern: ^[A-Z]{2}$

4950

49314951 - `region: optional string or null`

49324952

49334953 Region or state name.

from line 5256

52365256

52375257 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

52385258

5259 pattern: ^(0|[1-9]\d*)$

5260

52395261 - `currency: BetaCurrency`

52405262

52415263 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 5350

53285350

53295351 Full commit SHA to check out.

53305352

5331 minLength: 7, maxLength: 64

5353 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

53325354

53335355 - `BetaManagedAgentsFileResource object`

53345356

from line 5384

53625384

53635385 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

53645386

5387 pattern: ^memstore_[a-zA-Z0-9_]+$

5388

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

53665390

53675391 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 6295

62716295

62726296 Two-letter ISO 3166-1 country code, uppercase.

62736297

6298 pattern: ^[A-Z]{2}$

6299

62746300 - `region: optional string or null`

62756301

62766302 Region or state name.

from line 6425

63996425

64006426 Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.

64016427

6402 minLength: 1, maxLength: 128

6428 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$

64036429

64046430- `budget: optional BetaManagedAgentsBudgetLimit or null`

64056431

from line 6441

64156441

64166442 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

64176443

6444 pattern: ^(0|[1-9]\d*)$

6445

64186446 - `currency: BetaCurrency`

64196447

64206448 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 7029

70017029

70027030 Two-letter ISO 3166-1 country code, uppercase.

70037031

7032 pattern: ^[A-Z]{2}$

7033

70047034 - `region: optional string or null`

70057035

70067036 Region or state name.

from line 7339

73097339

73107340 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

73117341

7342 pattern: ^(0|[1-9]\d*)$

7343

73127344 - `currency: BetaCurrency`

73137345

73147346 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 7433

74017433

74027434 Full commit SHA to check out.

74037435

7404 minLength: 7, maxLength: 64

7436 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

74057437

74067438 - `BetaManagedAgentsFileResource object`

74077439

from line 7467

74357467

74367468 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

74377469

7470 pattern: ^memstore_[a-zA-Z0-9_]+$

7471

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

74397473

74407474 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 8135

81018135

81028136- `BetaManagedAgentsSession object`

81038137

8104 A Managed Agents `session`.

8105

8106 - `type: "session"`

8107

8108 - `id: string`

8109

8110 - `agent: BetaManagedAgentsSessionAgent`

8111

8112 Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time.

8113

8114 - `type: "agent"`

8115

8116 - `id: string`

8117

8118 - `description: string or null`

8119

8120 - `execution_identity: BetaManagedAgentsExecutionIdentity`

8121

8122 Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal.

8123

8124 - `BetaManagedAgentsAWSRoleExecutionIdentity object`

8125

8126 An AWS IAM role principal as returned in API responses.

8127

8128 - `type: "aws_role"`

8129

8130 - `role_arn: string`

8131

8132 The IAM role's ARN.

8133

8134 - `BetaManagedAgentsServiceAccountExecutionIdentity object`

8135

8136 The Anthropic-managed service account as returned in API responses.

8137

8138 - `type: "service_account"`

8139

8140 - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`

8141

8142 - `type: "url"`

8143

8144 - `name:

8138 A Managed Agents `se

api/beta/sessions/archive Changed · +7 / -1 lines

from line 711

711711

712712 Two-letter ISO 3166-1 country code, uppercase.

713713

714 pattern: ^[A-Z]{2}$

715

714716 - `region: optional string or null`

715717

716718 Region or state name.

from line 1021

10191021

10201022 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

10211023

1024 pattern: ^(0|[1-9]\d*)$

1025

10221026 - `currency: BetaCurrency`

10231027

10241028 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1115

11111115

11121116 Full commit SHA to check out.

11131117

1114 minLength: 7, maxLength: 64

1118 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

11151119

11161120 - `BetaManagedAgentsFileResource object`

11171121

from line 1148

11441148 - `memory_store_id: string`

11451149

11461150 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

1151

1152 pattern: ^memstore_[a-zA-Z0-9_]+$

11471153

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

11491155

api/beta/sessions/create Changed · +16 / -4 lines

from line 345

345345

346346 - `speed: optional "standard" or "fast" or null`

347347

348 Inference speed mode. Defaults to `standard`.

348 Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time.

349349

350350 - `"standard"`

351351

from line 793

793793

794794 Two-letter ISO 3166-1 country code, uppercase.

795795

796 pattern: ^[A-Z]{2}$

797

796798 - `region: optional string or null`

797799

798800 Region or state name.

from line 923

921923

922924 Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.

923925

924 minLength: 1, maxLength: 128

926 minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$

925927

926928 - `version: optional number`

927929

from line 951

949951

950952 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

951953

954 pattern: ^(0|[1-9]\d*)$

955

952956 - `currency: BetaCurrency`

953957

954958 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1207

12031207

12041208 Full commit SHA to check out.

12051209

1206 minLength: 7, maxLength: 64

1210 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

12071211

12081212 - `mount_path: optional string or null`

12091213

from line 1243

12391243

12401244 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

12411245

1246 pattern: ^memstore_[a-zA-Z0-9_]+$

1247

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

12431249

12441250 Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.

from line 1837

18311837

18321838 Two-letter ISO 3166-1 country code, uppercase.

18331839

1840 pattern: ^[A-Z]{2}$

1841

18341842 - `region: optional string or null`

18351843

18361844 Region or state name.

from line 2147

21392147

21402148 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

21412149

2150 pattern: ^(0|[1-9]\d*)$

2151

21422152 - `currency: BetaCurrency`

21432153

21442154 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 2241

22312241

22322242 Full commit SHA to check out.

22332243

2234 minLength: 7, maxLength: 64

2244 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

22352245

22362246 - `BetaManagedAgentsFileResource object`

22372247

from line 2274

22642274 - `memory_store_id: string`

22652275

22662276 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

2277

2278 pattern: ^memstore_[a-zA-Z0-9_]+$

22672279

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

22692281

api/beta/sessions/events Changed · +351 / -5 lines

### Beta Managed Agents Compaction Limit Reached Error ### Beta Managed Agents Tool Use Limit Reached Error

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 993

993993

994994 Unique identifier for this event.

995995

996 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

996 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

997997

998998 - `BetaManagedAgentsUnknownError object`

999999

from line 1225

12251225

12261226 ID of the vault containing the affected credential.

12271227

1228 - `BetaManagedAgentsToolUseLimitReachedError object`

1229

1230 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1231

1232 - `type: "tool_use_limit_reached_error"`

1233

1234 - `message: string`

1235

1236 Human-readable error description.

1237

1238 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1239

1240 What the client should do next.

1241

1242 - `BetaManagedAgentsRetryStatusRetrying object`

1243

1244 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1245

1246 - `BetaManagedAgentsRetryStatusExhausted object`

1247

1248 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1249

1250 - `BetaManagedAgentsRetryStatusTerminal object`

1251

1252 The session encountered a terminal error and will transition to `terminated` state.

1253

1254 - `BetaManagedAgentsCompactionLimitReachedError object`

1255

1256 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1257

1258 - `type: "compaction_limit_reached_error"`

1259

1260 - `message: string`

1261

1262 Human-readable error description.

1263

1264 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1265

1266 What the client should do next.

1267

1268 - `BetaManagedAgentsRetryStatusRetrying object`

1269

1270 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1271

1272 - `BetaManagedAgentsRetryStatusExhausted object`

1273

1274 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1275

1276 - `BetaManagedAgentsRetryStatusTerminal object`

1277

1278 The session encountered a terminal error and will transition to `terminated` state.

1279

12281280 - `BetaManagedAgentsRepositoryAuthenticationError object`

12291281

12301282 The repository host rejected the credentials, or required credentials and received none.

from line 2569

25172569

25182570 Two-letter ISO 3166-1 country code, uppercase.

25192571

2572 pattern: ^[A-Z]{2}$

2573

25202574 - `region: optional string or null`

25212575

25222576 Region or state name.

from line 2873

28192873

28202874 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

28212875

2876 pattern: ^(0|[1-9]\d*)$

2877

28222878 - `currency: BetaCurrency`

28232879

28242880 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 5163

51075163

51085164 Unique identifier for this event.

51095165

5110 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

5166 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

51115167

51125168 - `BetaManagedAgentsUnknownError object`

51135169

from line 5395

53395395

53405396 ID of the vault containing the affected credential.

53415397

5398 - `BetaManagedAgentsToolUseLimitReachedError object`

5399

5400 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

5401

5402 - `type: "tool_use_limit_reached_error"`

5403

5404 - `message: string`

5405

5406 Human-readable error description.

5407

5408 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

5409

5410 What the client should do next.

5411

5412 - `BetaManagedAgentsRetryStatusRetrying object`

5413

5414 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

5415

5416 - `BetaManagedAgentsRetryStatusExhausted object`

5417

5418 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

5419

5420 - `BetaManagedAgentsRetryStatusTerminal object`

5421

5422 The session encountered a terminal error and will transition to `terminated` state.

5423

5424 - `BetaManagedAgentsCompactionLimitReachedError object`

5425

5426 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

5427

5428 - `type: "compaction_limit_reached_error"`

5429

5430 - `message: string`

5431

5432 Human-readable error description.

5433

5434 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

5435

5436 What the client should do next.

5437

5438 - `BetaManagedAgentsRetryStatusRetrying object`

5439

5440 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

5441

5442 - `BetaManagedAgentsRetryStatusExhausted object`

5443

5444 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

5445

5446 - `BetaManagedAgentsRetryStatusTerminal object`

5447

5448 The session encountered a terminal error and will transition to `terminated` state.

5449

53425450 - `BetaManagedAgentsRepositoryAuthenticationError object`

53435451

53445452 The repository host rejected the credentials, or required credentials and received none.

from line 6739

66316739

66326740 Two-letter ISO 3166-1 country code, uppercase.

66336741

6742 pattern: ^[A-Z]{2}$

6743

66346744 - `region: optional string or null`

66356745

66366746 Region or state name.

from line 7043

69337043

69347044 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

69357045

7046 pattern: ^(0|[1-9]\d*)$

7047

69367048 - `currency: BetaCurrency`

69377049

69387050 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 8476

83648476

83658477 - `id: string`

83668478

8367 Unique identifier for this event.

8368

8369 - `processed_at: string`

8370

8371 Timestamp when this event was processed.

8372

8373 format: date-time

8374

8375 - `tool_use_id: string`

8376

8377 The id of the `agent.tool_use` event this result corresponds to.

8378

8379 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`

8380

8381 The result content returned by the tool.

8382

8383 - `BetaManagedAgentsTextBlock object`

8384

8385 Regular text content.

8386

8387 - `type: "text"`

8388

8389 - `text: string`

8390

8391 The text content.

8392

8393 minLength: 1

8394

8395 - `BetaManagedAgentsImageBlock object`

8396

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

8398

8399 - `type: "image"`

8400

8401 - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`

8402

8403 The source of the image data.

8404

8405 - `BetaManagedAgentsBase64ImageSource object`

8406

8407 Base64-encoded image data.

8408

8409 - `type: "base64"`

8410

8411 - `data: string`

8412

8413 Base64-encoded image data.

8414

8415 minLength: 1

8416

8417 - `media_type: string`

8418

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

8420

8421 minLength: 1

8422

8423 - `BetaManagedAgentsURLImageSource object`

8424

8425 Image referenced by URL.

8426

8427 - `type: "url"`

8428

8429 - `url: string`

8430

8431 URL of the image to fetch.

8432

8433 minLength: 1

8434

8435 - `BetaManagedAgentsFileImageSource object`

8436

8437 Image referenced by file ID.

8438

8439 - `type: "file"`

8440

8441 - `file_id: string`

8442

8443 ID of a previously uploaded file.

8444

8445 minLength: 1

8446

8447 - `BetaManagedAgentsDocumentBlock object`

8448

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

8450

8451 - `type: "document"`

8452

8453 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`

8454

8455 The source of the document data.

8456

8457 - `BetaManagedAgentsBase64DocumentSource object`

8458

8459 Base64-encoded document data.

8460

8461 - `type: "base64"`

8462

8463 - `data: string`

8464

8465 Base64-encoded document data.

8466

8467 minLength: 1

8468

8469 - `media_type: string`

8470

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

8472

8473 minLength: 1

8474

8475 - `BetaManagedAgentsPlainTextDocumentSource object`

8476

8477 Plain text document content.

8478

8479 - `type: "text"`

8480

8481 - `data: string`

8482

8483 The plain text content.

8484

8485 minLength: 1

8486

8487 - `media_type: "text/plain"`

8488

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

8490

8491 - `BetaManagedAgentsURLDocumentSource object`

8492

8493 Document referenced by URL.

8494

8495 - `type: "url"`

8496

8497 - `url: string`

8498

8499 URL of the document to fetch.

8500

8501 minLength: 1

8502

8503 - `BetaManagedAgentsFileDocumentSource object`

8504

8505 Document referenced by file ID.

8506

8507 - `type: "file"`

8508

8509 - `file_id: string`

8510

8511 ID of a previously uploaded file.

8512

8513 minLength: 1

8514

8515 - `context: optional string or null`

8516

8517 Additional context about the document for the model.

8518

8519 - `title: optional string or null`

8520

8521 The title of the document.

8522

8523 - `BetaManagedAgentsSearchResultBlock object`

8524

8525 A block containing a web search result.

8526

8527 - `type: "search_result"`

8528

8529 - `citations: BetaManagedAgentsSearchResultCitations`

8530

8531 Citation settings for this search result.

8532

8533 - `enabled: boolean`

8534

8535 Whether citations are enabled for this search result.

8536

8537 - `content: array of BetaManagedAgentsSearchResultContent`

8538

8539 Array of text content blocks from the search result.

8540

8541 - `type: "text"`

8542

8543 - `text: string`

8544

8545 The text content.

8546

8547 minLength: 1

8548

8549 - `source: string`

8550

8551 The URL source of the search result.

8552

8553 minLength: 1

8554

8555 - `title: string`

8556

8557 The title of the search result.

8558

8559 minLength: 1

8560

8561 - `is_error: optional boolean or null`

8562

8563 Whether the tool execution resulted in an error.

8564

8565### Beta Managed Agents Agent Tool Use Event

8566

8567- `BetaManagedAgentsAgentToolUseEvent object`

8568

8569 Event emitted when the agent invokes a built-in agent tool.

8570

8571 - `type: "agent.tool_use"`

8572

8573 - `id: string`

8574

8575 Unique identifier for this event.

8576

8577 - `input: map[unknown]`

8578

8579 Input parameters for the tool call.

8580

8581 - `name: string`

8582

8583 Name of the agent tool being used.

8584

8585 - `processed_at: string`

8586

8587 Timestamp when this event was processed.

8588

8589 format: date-time

8590

8591 - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission`

8592

8593 The evaluated permission policy for this tool invocation.

8594

8595 - `"allow"`

8596

8597 - `"ask"`

8598

8599 - `"deny"`

8600

8601 - `evaluation: optional BetaManagedAgentsAgentToolEvaluation`

8602

8603 Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (fo

8479

api/beta/sessions/events/list Changed · +57 / -1 lines

from line 991

991991

992992 Unique identifier for this event.

993993

994 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

994 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

995995

996996 - `BetaManagedAgentsUnknownError object`

997997

from line 1223

12231223

12241224 ID of the vault containing the affected credential.

12251225

1226 - `BetaManagedAgentsToolUseLimitReachedError object`

1227

1228 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1229

1230 - `type: "tool_use_limit_reached_error"`

1231

1232 - `message: string`

1233

1234 Human-readable error description.

1235

1236 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1237

1238 What the client should do next.

1239

1240 - `BetaManagedAgentsRetryStatusRetrying object`

1241

1242 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1243

1244 - `BetaManagedAgentsRetryStatusExhausted object`

1245

1246 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1247

1248 - `BetaManagedAgentsRetryStatusTerminal object`

1249

1250 The session encountered a terminal error and will transition to `terminated` state.

1251

1252 - `BetaManagedAgentsCompactionLimitReachedError object`

1253

1254 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1255

1256 - `type: "compaction_limit_reached_error"`

1257

1258 - `message: string`

1259

1260 Human-readable error description.

1261

1262 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1263

1264 What the client should do next.

1265

1266 - `BetaManagedAgentsRetryStatusRetrying object`

1267

1268 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1269

1270 - `BetaManagedAgentsRetryStatusExhausted object`

1271

1272 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1273

1274 - `BetaManagedAgentsRetryStatusTerminal object`

1275

1276 The session encountered a terminal error and will transition to `terminated` state.

1277

12261278 - `BetaManagedAgentsRepositoryAuthenticationError object`

12271279

12281280 The repository host rejected the credentials, or required credentials and received none.

from line 2567

25152567

25162568 Two-letter ISO 3166-1 country code, uppercase.

25172569

2570 pattern: ^[A-Z]{2}$

2571

25182572 - `region: optional string or null`

25192573

25202574 Region or state name.

from line 2870

28162870 - `amount: string`

28172871

28182872 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

2873

2874 pattern: ^(0|[1-9]\d*)$

28192875

28202876 - `currency: BetaCurrency`

28212877

api/beta/sessions/events/stream Changed · +57 / -1 lines

from line 873

873873

874874 Unique identifier for this event.

875875

876 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

876 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

877877

878878 - `BetaManagedAgentsUnknownError object`

879879

from line 1105

11051105

11061106 ID of the vault containing the affected credential.

11071107

1108 - `BetaManagedAgentsToolUseLimitReachedError object`

1109

1110 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1111

1112 - `type: "tool_use_limit_reached_error"`

1113

1114 - `message: string`

1115

1116 Human-readable error description.

1117

1118 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1119

1120 What the client should do next.

1121

1122 - `BetaManagedAgentsRetryStatusRetrying object`

1123

1124 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1125

1126 - `BetaManagedAgentsRetryStatusExhausted object`

1127

1128 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1129

1130 - `BetaManagedAgentsRetryStatusTerminal object`

1131

1132 The session encountered a terminal error and will transition to `terminated` state.

1133

1134 - `BetaManagedAgentsCompactionLimitReachedError object`

1135

1136 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1137

1138 - `type: "compaction_limit_reached_error"`

1139

1140 - `message: string`

1141

1142 Human-readable error description.

1143

1144 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1145

1146 What the client should do next.

1147

1148 - `BetaManagedAgentsRetryStatusRetrying object`

1149

1150 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1151

1152 - `BetaManagedAgentsRetryStatusExhausted object`

1153

1154 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1155

1156 - `BetaManagedAgentsRetryStatusTerminal object`

1157

1158 The session encountered a terminal error and will transition to `terminated` state.

1159

11081160 - `BetaManagedAgentsRepositoryAuthenticationError object`

11091161

11101162 The repository host rejected the credentials, or required credentials and received none.

from line 2449

23972449

23982450 Two-letter ISO 3166-1 country code, uppercase.

23992451

2452 pattern: ^[A-Z]{2}$

2453

24002454 - `region: optional string or null`

24012455

24022456 Region or state name.

from line 2752

26982752 - `amount: string`

26992753

27002754 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

2755

2756 pattern: ^(0|[1-9]\d*)$

27012757

27022758 - `currency: BetaCurrency`

27032759

api/beta/sessions/list Changed · +7 / -1 lines

from line 793

793793

794794 Two-letter ISO 3166-1 country code, uppercase.

795795

796 pattern: ^[A-Z]{2}$

797

796798 - `region: optional string or null`

797799

798800 Region or state name.

from line 1103

11011103

11021104 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

11031105

1106 pattern: ^(0|[1-9]\d*)$

1107

11041108 - `currency: BetaCurrency`

11051109

11061110 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1197

11931197

11941198 Full commit SHA to check out.

11951199

1196 minLength: 7, maxLength: 64

1200 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

11971201

11981202 - `BetaManagedAgentsFileResource object`

11991203

from line 1230

12261230 - `memory_store_id: string`

12271231

12281232 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

1233

1234 pattern: ^memstore_[a-zA-Z0-9_]+$

12291235

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

12311237

api/beta/sessions/resources Changed · +21 / -7 lines

from line 413

413413

414414 Full commit SHA to check out.

415415

416 minLength: 7, maxLength: 64

416 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

417417

418418 - `BetaManagedAgentsFileResource object`

419419

from line 447

447447

448448 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

449449

450 pattern: ^memstore_[a-zA-Z0-9_]+$

451

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

451453

452454 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 704

702704

703705 Full commit SHA to check out.

704706

705 minLength: 7, maxLength: 64

707 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

706708

707709- `BetaManagedAgentsFileResource object`

708710

from line 738

736738

737739 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

738740

741 pattern: ^memstore_[a-zA-Z0-9_]+$

742

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

740744

741745 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 986

982986

983987 Full commit SHA to check out.

984988

985 minLength: 7, maxLength: 64

989 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

986990

987991- `BetaManagedAgentsFileResource object`

988992

from line 1020

10161020

10171021 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

10181022

1023 pattern: ^memstore_[a-zA-Z0-9_]+$

1024

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

10201026

10211027 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 1329

13231329

13241330 Full commit SHA to check out.

13251331

1326 minLength: 7, maxLength: 64

1332 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

13271333

13281334### Beta Managed Agents Memory Store Resource

13291335

from line 1343

13371343

13381344 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

13391345

1346 pattern: ^memstore_[a-zA-Z0-9_]+$

1347

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

13411349

13421350 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 1417

14091417

14101418 Full commit SHA to check out.

14111419

1412 minLength: 7, maxLength: 64

1420 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

14131421

14141422 - `BetaManagedAgentsFileResource object`

14151423

from line 1451

14431451

14441452 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

14451453

1454 pattern: ^memstore_[a-zA-Z0-9_]+$

1455

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

14471457

14481458 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 1527

15171527

15181528 Full commit SHA to check out.

15191529

1520 minLength: 7, maxLength: 64

1530 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

15211531

15221532 - `BetaManagedAgentsFileResource object`

15231533

from line 1561

15511561

15521562 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

15531563

1564 pattern: ^memstore_[a-zA-Z0-9_]+$

1565

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

15551567

15561568 Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem.

from line 1637

16251637

16261638 Full commit SHA to check out.

16271639

1628 minLength: 7, maxLength: 64

1640 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

16291641

16301642 - `BetaManagedAgentsFileResource object`

16311643

from line 1670

16581670 - `memory_store_id: string`

16591671

16601672 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

1673

1674 pattern: ^memstore_[a-zA-Z0-9_]+$

16611675

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

16631677

api/beta/sessions/retrieve Changed · +7 / -1 lines

from line 711

711711

712712 Two-letter ISO 3166-1 country code, uppercase.

713713

714 pattern: ^[A-Z]{2}$

715

714716 - `region: optional string or null`

715717

716718 Region or state name.

from line 1021

10191021

10201022 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

10211023

1024 pattern: ^(0|[1-9]\d*)$

1025

10221026 - `currency: BetaCurrency`

10231027

10241028 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1115

11111115

11121116 Full commit SHA to check out.

11131117

1114 minLength: 7, maxLength: 64

1118 minLength: 7, maxLength: 64, pattern: ^[0-9a-fA-F]+$

11151119

11161120 - `BetaManagedAgentsFileResource object`

11171121

from line 1148

11441148 - `memory_store_id: string`

11451149

11461150 The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

1151

1152 pattern: ^memstore_[a-zA-Z0-9_]+$

11471153

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

11491155

api/beta/sessions/threads Changed · +191 / -3 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 705

705705

706706 Two-letter ISO 3166-1 country code, uppercase.

707707

708 pattern: ^[A-Z]{2}$

709

708710 - `region: optional string or null`

709711

710712 Region or state name.

from line 981

979981

980982 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

981983

984 pattern: ^(0|[1-9]\d*)$

985

982986 - `currency: BetaCurrency`

983987

984988 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 1800

17961800

17971801 Two-letter ISO 3166-1 country code, uppercase.

17981802

1803 pattern: ^[A-Z]{2}$

1804

17991805 - `region: optional string or null`

18001806

18011807 Region or state name.

from line 2076

20702076

20712077 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

20722078

2079 pattern: ^(0|[1-9]\d*)$

2080

20732081 - `currency: BetaCurrency`

20742082

20752083 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 2886

28782886

28792887 Two-letter ISO 3166-1 country code, uppercase.

28802888

2889 pattern: ^[A-Z]{2}$

2890

28812891 - `region: optional string or null`

28822892

28832893 Region or state name.

from line 3162

31523162

31533163 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

31543164

3165 pattern: ^(0|[1-9]\d*)$

3166

31553167 - `currency: BetaCurrency`

31563168

31573169 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 3819

38073819

38083820 Two-letter ISO 3166-1 country code, uppercase.

38093821

3822 pattern: ^[A-Z]{2}$

3823

38103824 - `region: optional string or null`

38113825

38123826 Region or state name.

from line 4459

44454459

44464460 Two-letter ISO 3166-1 country code, uppercase.

44474461

4462 pattern: ^[A-Z]{2}$

4463

44484464 - `region: optional string or null`

44494465

44504466 Region or state name.

from line 4735

47194735

47204736 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

47214737

4738 pattern: ^(0|[1-9]\d*)$

4739

47224740 - `currency: BetaCurrency`

47234741

47244742 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 4851

48334851

48344852 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

48354853

4854 pattern: ^(0|[1-9]\d*)$

4855

48364856 - `currency: BetaCurrency`

48374857

48384858 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 5599

55795599

55805600 Unique identifier for this event.

55815601

5582 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

5602 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

55835603

55845604 - `BetaManagedAgentsUnknownError object`

55855605

from line 5831

58115831

58125832 ID of the vault containing the affected credential.

58135833

5834 - `BetaManagedAgentsToolUseLimitReachedError object`

5835

5836 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

5837

5838 - `type: "tool_use_limit_reached_error"`

5839

5840 - `message: string`

5841

5842 Human-readable error description.

5843

5844 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

5845

5846 What the client should do next.

5847

5848 - `BetaManagedAgentsRetryStatusRetrying object`

5849

5850 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

5851

5852 - `BetaManagedAgentsRetryStatusExhausted object`

5853

5854 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

5855

5856 - `BetaManagedAgentsRetryStatusTerminal object`

5857

5858 The session encountered a terminal error and will transition to `terminated` state.

5859

5860 - `BetaManagedAgentsCompactionLimitReachedError object`

5861

5862 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

5863

5864 - `type: "compaction_limit_reached_error"`

5865

5866 - `message: string`

5867

5868 Human-readable error description.

5869

5870 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

5871

5872 What the client should do next.

5873

5874 - `BetaManagedAgentsRetryStatusRetrying object`

5875

5876 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

5877

5878 - `BetaManagedAgentsRetryStatusExhausted object`

5879

5880 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

5881

5882 - `BetaManagedAgentsRetryStatusTerminal object`

5883

5884 The session encountered a terminal error and will transition to `terminated` state.

5885

58145886 - `BetaManagedAgentsRepositoryAuthenticationError object`

58155887

58165888 The repository host rejected the credentials, or required credentials and received none.

from line 7175

71037175

71047176 Two-letter ISO 3166-1 country code, uppercase.

71057177

7178 pattern: ^[A-Z]{2}$

7179

71067180 - `region: optional string or null`

71077181

71087182 Region or state name.

from line 7479

74057479

74067480 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

74077481

7482 pattern: ^(0|[1-9]\d*)$

7483

74087484 - `currency: BetaCurrency`

74097485

74107486 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 8149

80738149

80748150 - `BetaManagedAgentsDocumentBlock object`

80758151

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

8077

8078 - `type: "document"`

8079

8080 - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`

8081

8082 The source of the document data.

8083

8084 - `BetaManagedAgentsBase64DocumentSource object`

8085

8086 Base64-encoded document data.

8087

8088 - `type: "base64"`

8089

8090 - `data: string`

8091

8092 Base64-encoded document data.

8093

8094 minLength: 1

8095

8096 - `media_type: string`

8097

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

8099

8100 minLength: 1

8101

8102 - `BetaManagedAgentsPlainTextDocumentSource object`

8103

8104 Plain text document content.

8105

8106 - `type: "text"`

8107

8108 - `data: string`

8109

8110 The plain text content.

8111

8112 minLength: 1

8113

8114 - `media_type: "text/plain"`

8115

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

8117

8118 - `BetaManagedAgentsURLDocumentSource object`

8119

8120 Document referenced by URL.

8121

8122 - `type: "url"`

8123

8124 - `url: string`

8125

8126 URL of the document to fetch.

8127

8128 minLength: 1

8129

8130 - `BetaManagedAgentsFileDocumentSource object`

8131

8132 Document referenced by file ID.

8133

8134 - `type: "file"`

8135

8136 - `file_id: string`

8137

8138 ID of a previously uploaded file.

8139

8140 minLength: 1

8141

8142 - `context: optional string or null`

8143

8144 Additional context about the document for the model.

8145

8146 - `title: optional string or null`

8147

8148 The title of the document.

8149

8150 - `BetaManagedAgentsRedactedBlock object`

8151

8152 Placeholder for content withheld by Anthropic model policy.

8153

8154 - `type: "redacted"`

8155

8156 - `processed_at: optional string or null`

8157

8158 Timestamp when the agent finished processing this message.

8159

8160 format: date-time

8161

8162 - `BetaManagedAgentsUserInterruptEvent object`

8163

8164 An interrupt event that pauses agent execution and returns control to the user.

8165

8166 - `type: "user.interrupt"`

8167

8168 - `id: string`

8169

8170 Unique identifier for this event.

8171

8172 - `processed_at: optional string or null`

8173

8174 Timestamp when the interrupt was processed.

8175

8176 format: date-time

8177

8178 - `session_thread_id: optional string or null`

8179

8180 If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread.

8181

8182 - `BetaManagedAgentsUserToolConfirmationEvent object`

8183

8184 A tool confirmation event that approves or denies a pending tool execution.

8185

8186 - `type: "user.tool_confirmation"`

8187

8188 - `id: string`

8189

8190 Unique identifier for this event.

8191

8192 - `result: "allow" or "deny"`

8193

8194 The confirmation result: 'allow' or 'deny'.

8195

8196 - `"allow"`

8197

8198 - `"deny"`

8199

8200 - `tool_use_id: string`

8201

8202 The id of the `agent.tool_use` or `agent

8152 Document content, either specified directly as base64 dat

api/beta/sessions/threads/events Changed · +114 / -2 lines

from line 875

875875

876876 Unique identifier for this event.

877877

878 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

878 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

879879

880880 - `BetaManagedAgentsUnknownError object`

881881

from line 1107

11071107

11081108 ID of the vault containing the affected credential.

11091109

1110 - `BetaManagedAgentsToolUseLimitReachedError object`

1111

1112 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1113

1114 - `type: "tool_use_limit_reached_error"`

1115

1116 - `message: string`

1117

1118 Human-readable error description.

1119

1120 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1121

1122 What the client should do next.

1123

1124 - `BetaManagedAgentsRetryStatusRetrying object`

1125

1126 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1127

1128 - `BetaManagedAgentsRetryStatusExhausted object`

1129

1130 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1131

1132 - `BetaManagedAgentsRetryStatusTerminal object`

1133

1134 The session encountered a terminal error and will transition to `terminated` state.

1135

1136 - `BetaManagedAgentsCompactionLimitReachedError object`

1137

1138 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

1139

1140 - `type: "compaction_limit_reached_error"`

1141

1142 - `message: string`

1143

1144 Human-readable error description.

1145

1146 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

1147

1148 What the client should do next.

1149

1150 - `BetaManagedAgentsRetryStatusRetrying object`

1151

1152 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

1153

1154 - `BetaManagedAgentsRetryStatusExhausted object`

1155

1156 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

1157

1158 - `BetaManagedAgentsRetryStatusTerminal object`

1159

1160 The session encountered a terminal error and will transition to `terminated` state.

1161

11101162 - `BetaManagedAgentsRepositoryAuthenticationError object`

11111163

11121164 The repository host rejected the credentials, or required credentials and received none.

from line 2451

23992451

24002452 Two-letter ISO 3166-1 country code, uppercase.

24012453

2454 pattern: ^[A-Z]{2}$

2455

24022456 - `region: optional string or null`

24032457

24042458 Region or state name.

from line 2755

27012755

27022756 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

27032757

2758 pattern: ^(0|[1-9]\d*)$

2759

27042760 - `currency: BetaCurrency`

27052761

27062762 Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

from line 4054

39984054

39994055 Unique identifier for this event.

40004056

4001 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more`

4057 - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 12 more`

40024058

40034059 - `BetaManagedAgentsUnknownError object`

40044060

from line 4286

42304286

42314287 ID of the vault containing the affected credential.

42324288

4289 - `BetaManagedAgentsToolUseLimitReachedError object`

4290

4291 The turn stopped because the agent loop reached its limit on tool-use rounds (one model response that calls tools, plus running those tools, is one round), not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

4292

4293 - `type: "tool_use_limit_reached_error"`

4294

4295 - `message: string`

4296

4297 Human-readable error description.

4298

4299 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

4300

4301 What the client should do next.

4302

4303 - `BetaManagedAgentsRetryStatusRetrying object`

4304

4305 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

4306

4307 - `BetaManagedAgentsRetryStatusExhausted object`

4308

4309 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

4310

4311 - `BetaManagedAgentsRetryStatusTerminal object`

4312

4313 The session encountered a terminal error and will transition to `terminated` state.

4314

4315 - `BetaManagedAgentsCompactionLimitReachedError object`

4316

4317 The turn stopped because the context was compacted the maximum number of times in a row without the model producing a message or a tool call, not because a request failed. The thread goes idle with `stop_reason: retries_exhausted` (a child thread then terminates); the next `user.message` starts a new turn.

4318

4319 - `type: "compaction_limit_reached_error"`

4320

4321 - `message: string`

4322

4323 Human-readable error description.

4324

4325 - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal`

4326

4327 What the client should do next.

4328

4329 - `BetaManagedAgentsRetryStatusRetrying object`

4330

4331 The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out.

4332

4333 - `BetaManagedAgentsRetryStatusExhausted object`

4334

4335 This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt.

4336

4337 - `BetaManagedAgentsRetryStatusTerminal object`

4338

4339 The session encountered a terminal error and will transition to `terminated` state.

4340

42334341 - `BetaManagedAgentsRepositoryAuthenticationError object`

42344342

42354343 The repository host rejected the credentials, or required credentials and received none.

from line 5630

55225630

55235631 Two-letter ISO 3166-1 country code, uppercase.

55245632

5633 pattern: ^[A-Z]{2}$

5634

55255635 - `region: optional string or null`

55265636

55275637 Region or state name.

from line 5933

58235933 - `amount: string`

58245934

58255935 Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

5936

5937 pattern: ^(0|[1-9]\d*)$

58265938

58275939 - `currency: BetaCurrency`

58285940

One read of Claude Developer Platformapi-20261105T050710Z

What this read moved

api/beta/organization/claude_tag Changed · +4 / -4 lines

api/beta/organization/claude_tag/slack_channels Changed · +5 / -5 lines

api/beta/organization/rbac_groups Changed · +44 / -40 lines

api/beta/organization/rbac_groups/delete Changed · +8 / -6 lines

api/beta/organization/rbac_groups/members Changed · +33 / -31 lines

api/beta/organization/rbac_groups/members/remove Changed · +9 / -7 lines

api/beta/organization/spend_limits Changed · +26 / -10 lines

api/beta/organization/spend_limits/increase_requests Changed · +130 / -14 lines

api/beta/organization/spend_limits/increase_requests/approve Changed · +7 / -3 lines

api/beta/organization/spend_limits/increase_requests/deny Changed · +6 / -2 lines

api/beta/organization/spend_limits/increase_requests/list Changed · +6 / -2 lines

api/beta/organization/spend_limits/increase_requests/retrieve Changed · +6 / -2 lines

api/beta/organization/usage_report Changed · +6 / -6 lines

api/beta/organization/usage_report/retrieve_messages Changed · +3 / -3 lines

api/beta/sessions Changed · +342 / -22 lines

api/beta/sessions/archive Changed · +7 / -1 lines

api/beta/sessions/create Changed · +16 / -4 lines

api/beta/sessions/events Changed · +351 / -5 lines

api/beta/sessions/events/list Changed · +57 / -1 lines

api/beta/sessions/events/stream Changed · +57 / -1 lines

api/beta/sessions/list Changed · +7 / -1 lines

api/beta/sessions/resources Changed · +21 / -7 lines

api/beta/sessions/retrieve Changed · +7 / -1 lines

api/beta/sessions/threads Changed · +191 / -3 lines

api/beta/sessions/threads/events Changed · +114 / -2 lines