What this read moved
76–100 of 239This capture is too large to show at once. Changes 76-100 of 239 are below, significant first; the rest are on the following screens.
api/beta/sessions/resources Changed · +20 / -0 lines
from line 119
119119
120120- `"anthropic-workspace-id": optional string`
121121
122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
123
124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
125
122126### Body parameters
123127
124128- `file_id: string`
from line 317
313317
314318- `"anthropic-workspace-id": optional string`
315319
320 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
321
322 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
323
316324### Returns
317325
318326- `data: array of BetaManagedAgentsSessionResource`
from line 588
580588
581589- `"anthropic-workspace-id": optional string`
582590
591 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
592
593 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
594
583595### Returns
584596
585597- `BetaManagedAgentsGitHubRepositoryResource object`
from line 838
826838
827839- `"anthropic-workspace-id": optional string`
828840
841 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
842
843 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
844
829845### Body parameters
830846
831847- `authorization_token: string`
from line 1099
10831099 - `"compact-2026-09-04"`
10841100
10851101- `"anthropic-workspace-id": optional string`
1102
1103 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1104
1105 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
10861106
10871107### Returns
10881108
api/beta/sessions/retrieve Changed · +12 / -0 lines
from line 117
117117
118118- `"anthropic-workspace-id": optional string`
119119
120 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
121
122 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123
120124## Returns
121125
122126- `BetaManagedAgentsSession object`
from line 919
915919
916920 - `"rescheduling"`
917921
922 Transient error occurred, retrying automatically.
923
918924 - `"running"`
919925
926 Agent is actively executing.
927
920928 - `"idle"`
921929
930 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
931
922932 - `"terminated"`
933
934 Session has ended, either due to an error or completion.
923935
924936 - `title: string or null`
925937
api/beta/sessions/threads Changed · +24 / -8 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 131
131131
132132- `"anthropic-workspace-id": optional string`
133133
134 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
135
136 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
137
134138### Returns
135139
136140- `data: optional array of BetaManagedAgentsSessionThread`
from line 149
145149
146150 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
147151
148 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
152 The resolved agent a `session_thread` runs.
149153
150154 - `BetaManagedAgentsSessionThreadAgent object`
151155
from line 1040
10361040
10371041- `"anthropic-workspace-id": optional string`
10381042
1043 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1044
1045 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1046
10391047### Returns
10401048
10411049- `BetaManagedAgentsSessionThread object`
from line 1058
10501058
10511059 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
10521060
1053 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
1061 The resolved agent a `session_thread` runs.
10541062
10551063 - `BetaManagedAgentsSessionThreadAgent object`
10561064
from line 1940
19321940
19331941- `"anthropic-workspace-id": optional string`
19341942
1943 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1944
1945 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1946
19351947### Returns
19361948
19371949- `BetaManagedAgentsSessionThread object`
from line 1958
19461958
19471959 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
19481960
1949 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
1961 The resolved agent a `session_thread` runs.
19501962
19511963 - `BetaManagedAgentsSessionThreadAgent object`
19521964
from line 2741
27292741
27302742 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
27312743
2732 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
2744 The resolved agent a `session_thread` runs.
27332745
27342746 - `BetaManagedAgentsSessionThreadAgent object`
27352747
from line 5823
58115823
58125824- `limit: optional number`
58135825
5814 Query parameter for limit
5815
58165826 format: int32
58175827
58185828- `page: optional string`
58195829
5820 Query parameter for page
5821
58225830#### Headers
58235831
58245832- `"anthropic-beta": optional array of AnthropicBeta`
from line 5931
59235931
59245932- `"anthropic-workspace-id": optional string`
59255933
5934 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
5935
5936 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
5937
59265938#### Returns
59275939
59285940- `data: optional array of BetaManagedAgentsSessionEvent`
from line 8327
83158327
83168328- `"anthropic-workspace-id": optional string`
83178329
8330 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
8331
8332 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
8333
83188334#### Returns
83198335
83208336- `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 34 more`
from line 8569
85538569
85548570 - `id: string`
85558571
8556 Unique identifier for this event.
8557
8558 - `custom_tool_use_id: string`
8559
8560 The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field.
8561
8562 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock`
8563
8564 The result content returned by the tool.
8565
8566 - `BetaManagedAgentsTextBlock object`
8567
8568 Regular text content.
8569
8570 - `BetaManagedAgentsImageBlock object`
8571
8572 Image content specified directly as base64 data or as a reference via a URL.
8573
8574 - `BetaManagedAgentsDocumentBlock object`
8575
8576 Document content, either specified directly as base64 data, as text, or as a reference via a URL.
8577
8578 - `BetaManagedAgentsSearchResultBlock object`
8579
8580 A block containing a web search result.
8581
8582 - `type: "search_result"`
8583
8584 - `citations: BetaManagedAgentsSearchRe
8572 Unique identifi
api/beta/sessions/threads/archive Changed · +5 / -1 lines
from line 119
119119
120120- `"anthropic-workspace-id": optional string`
121121
122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
123
124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
125
122126## Returns
123127
124128- `BetaManagedAgentsSessionThread object`
from line 137
133137
134138 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
135139
136 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
140 The resolved agent a `session_thread` runs.
137141
138142 - `BetaManagedAgentsSessionThreadAgent object`
139143
api/beta/sessions/threads/events Changed · +8 / -4 lines
from line 21
2121
2222- `limit: optional number`
2323
24 Query parameter for limit
25
2624 format: int32
2725
2826- `page: optional string`
2927
30 Query parameter for page
31
3228### Headers
3329
3430- `"anthropic-beta": optional array of AnthropicBeta`
from line 129
133129
134130- `"anthropic-workspace-id": optional string`
135131
132 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
133
134 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
135
136136### Returns
137137
138138- `data: optional array of BetaManagedAgentsSessionEvent`
from line 2524
25242524 - `"compact-2026-09-04"`
25252525
25262526- `"anthropic-workspace-id": optional string`
2527
2528 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
2529
2530 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
25272531
25282532### Returns
25292533
api/beta/sessions/threads/events/list Changed · +4 / -4 lines
from line 19
1919
2020- `limit: optional number`
2121
22 Query parameter for limit
23
2422 format: int32
2523
2624- `page: optional string`
2725
28 Query parameter for page
29
3026## Headers
3127
3228- `"anthropic-beta": optional array of AnthropicBeta`
from line 126
130126 - `"compact-2026-09-04"`
131127
132128- `"anthropic-workspace-id": optional string`
129
130 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
131
132 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
133133
134134## Returns
135135
api/beta/sessions/threads/list Changed · +5 / -1 lines
from line 129
129129
130130- `"anthropic-workspace-id": optional string`
131131
132 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
133
134 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
135
132136## Returns
133137
134138- `data: optional array of BetaManagedAgentsSessionThread`
from line 147
143147
144148 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
145149
146 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
150 The resolved agent a `session_thread` runs.
147151
148152 - `BetaManagedAgentsSessionThreadAgent object`
149153
api/beta/sessions/threads/retrieve Changed · +5 / -1 lines
from line 119
119119
120120- `"anthropic-workspace-id": optional string`
121121
122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
123
124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
125
122126## Returns
123127
124128- `BetaManagedAgentsSessionThread object`
from line 137
133137
134138 - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor`
135139
136 The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot.
140 The resolved agent a `session_thread` runs.
137141
138142 - `BetaManagedAgentsSessionThreadAgent object`
139143
api/beta/sessions/update Changed · +12 / -0 lines
from line 117
117117
118118- `"anthropic-workspace-id": optional string`
119119
120 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
121
122 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123
120124## Body parameters
121125
122126- `agent: optional BetaManagedAgentsSessionAgentUpdate`
from line 1405
14011405
14021406 - `"rescheduling"`
14031407
1408 Transient error occurred, retrying automatically.
1409
14041410 - `"running"`
14051411
1412 Agent is actively executing.
1413
14061414 - `"idle"`
14071415
1416 Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle.
1417
14081418 - `"terminated"`
1419
1420 Session has ended, either due to an error or completion.
14091421
14101422 - `title: string or null`
14111423
api/beta/skills Changed · +36 / -0 lines
from line 115
115115
116116- `"anthropic-workspace-id": optional string`
117117
118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
119
120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121
118122### Body parameters (form-data)
119123
120124- `files: array of string`
from line 364
360364
361365- `"anthropic-workspace-id": optional string`
362366
367 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
368
369 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
370
363371### Returns
364372
365373- `data: array of BetaSkill`
from line 593
585593
586594- `"anthropic-workspace-id": optional string`
587595
596 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
597
598 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
599
588600### Returns
589601
590602- `BetaSkill object`
from line 809
797809
798810- `"anthropic-workspace-id": optional string`
799811
812 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
813
814 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
815
800816### Returns
801817
802818- `BetaDeletedSkill object`
from line 1082
10661082
10671083- `"anthropic-workspace-id": optional string`
10681084
1085 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1086
1087 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1088
10691089#### Body parameters (form-data)
10701090
10711091- `files: array of string`
from line 1291
12711291
12721292- `"anthropic-workspace-id": optional string`
12731293
1294 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1295
1296 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1297
12741298#### Returns
12751299
12761300- `data: array of BetaSkillVersion`
from line 1495
14711495
14721496- `"anthropic-workspace-id": optional string`
14731497
1498 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1499
1500 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1501
14741502#### Example
14751503
14761504```bash
from line 1631
16031631
16041632- `"anthropic-workspace-id": optional string`
16051633
1634 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1635
1636 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1637
16061638#### Returns
16071639
16081640- `BetaSkillVersion object`
from line 1821
17891821 - `"compact-2026-09-04"`
17901822
17911823- `"anthropic-workspace-id": optional string`
1824
1825 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1826
1827 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
17921828
17931829#### Returns
17941830
api/beta/skills/versions Changed · +20 / -0 lines
from line 123
123123
124124- `"anthropic-workspace-id": optional string`
125125
126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
127
128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
129
126130### Body parameters (form-data)
127131
128132- `files: array of string`
from line 332
328332
329333- `"anthropic-workspace-id": optional string`
330334
335 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
336
337 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
338
331339### Returns
332340
333341- `data: array of BetaSkillVersion`
from line 536
528536
529537- `"anthropic-workspace-id": optional string`
530538
539 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
540
541 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
542
531543### Example
532544
533545```bash
from line 672
660672
661673- `"anthropic-workspace-id": optional string`
662674
675 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
676
677 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
678
663679### Returns
664680
665681- `BetaSkillVersion object`
from line 862
846862 - `"compact-2026-09-04"`
847863
848864- `"anthropic-workspace-id": optional string`
865
866 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
867
868 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
849869
850870### Returns
851871
api/beta/tunnels Changed · +60 / -0 lines
from line 117
117117
118118- `"anthropic-workspace-id": optional string`
119119
120 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
121
122 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123
120124### Body parameters
121125
122126- `display_name: optional string or null`
from line 197
193197
194198- `tunnel_id: string`
195199
200 ID of the tunnel (`tnl_...`).
201
196202### Headers
197203
198204- `"anthropic-beta": optional array of AnthropicBeta`
from line 303
297303
298304- `"anthropic-workspace-id": optional string`
299305
306 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
307
308 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
309
300310### Returns
301311
302312- `BetaTunnel object`
from line 489
479489
480490- `"anthropic-workspace-id": optional string`
481491
492 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
493
494 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
495
482496### Returns
483497
484498- `data: array of BetaTunnel`
from line 568
554568
555569- `tunnel_id: string`
556570
571 ID of the tunnel (`tnl_...`).
572
557573### Headers
558574
559575- `"anthropic-beta": optional array of AnthropicBeta`
from line 674
658674
659675- `"anthropic-workspace-id": optional string`
660676
677 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
678
679 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
680
661681### Returns
662682
663683- `BetaTunnel object`
from line 745
725745
726746- `tunnel_id: string`
727747
748 ID of the tunnel (`tnl_...`).
749
728750### Headers
729751
730752- `"anthropic-beta": optional array of AnthropicBeta`
from line 851
829851
830852- `"anthropic-workspace-id": optional string`
831853
854 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
855
856 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
857
832858### Returns
833859
834860- `BetaTunnelToken object`
from line 903
877903
878904- `tunnel_id: string`
879905
906 ID of the tunnel (`tnl_...`).
907
880908### Headers
881909
882910- `"anthropic-beta": optional array of AnthropicBeta`
from line 1009
9811009
9821010- `"anthropic-workspace-id": optional string`
9831011
1012 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1013
1014 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1015
9841016### Body parameters
9851017
9861018- `reason: optional string or null`
from line 1122
10901122
10911123- `tunnel_id: string`
10921124
1125 ID of the tunnel (`tnl_...`).
1126
10931127#### Headers
10941128
10951129- `"anthropic-beta": optional array of AnthropicBeta`
from line 1228
11941228
11951229- `"anthropic-workspace-id": optional string`
11961230
1231 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1232
1233 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1234
11971235#### Body parameters
11981236
11991237- `ca_certificate_pem: string`
from line 1317
12791317
12801318- `tunnel_id: string`
12811319
1320 ID of the tunnel (`tnl_...`).
1321
12821322- `certificate_id: string`
12831323
1324 ID of the certificate (`tcrt_...`).
1325
12841326#### Headers
12851327
12861328- `"anthropic-beta": optional array of AnthropicBeta`
from line 1427
13851427
13861428- `"anthropic-workspace-id": optional string`
13871429
1430 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1431
1432 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1433
13881434#### Returns
13891435
13901436- `BetaTunnelCertificate object`
from line 1504
14581504
14591505- `tunnel_id: string`
14601506
1507 ID of the tunnel (`tnl_...`).
1508
14611509#### Query parameters
14621510
14631511- `include_archived: optional boolean`
from line 1626
15781626
15791627- `"anthropic-workspace-id": optional string`
15801628
1629 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1630
1631 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1632
15811633#### Returns
15821634
15831635- `data: array of BetaTunnelCertificate`
from line 1712
16601712
16611713- `tunnel_id: string`
16621714
1715 ID of the tunnel (`tnl_...`).
1716
16631717- `certificate_id: string`
16641718
1719 ID of the certificate to archive (`tcrt_...`).
1720
16651721#### Headers
16661722
16671723- `"anthropic-beta": optional array of AnthropicBeta`
from line 1821
17651821 - `"compact-2026-09-04"`
17661822
17671823- `"anthropic-workspace-id": optional string`
1824
1825 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1826
1827 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
17681828
17691829#### Returns
17701830
api/beta/tunnels/archive Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Headers
1921
2022- `"anthropic-beta": optional array of AnthropicBeta`
from line 120
118120 - `"compact-2026-09-04"`
119121
120122- `"anthropic-workspace-id": optional string`
123
124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
125
126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121127
122128## Returns
123129
api/beta/tunnels/certificates Changed · +28 / -0 lines
from line 17
1717
1818- `tunnel_id: string`
1919
20 ID of the tunnel (`tnl_...`).
21
2022### Headers
2123
2224- `"anthropic-beta": optional array of AnthropicBeta`
from line 123
121123
122124- `"anthropic-workspace-id": optional string`
123125
126 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
127
128 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
129
124130### Body parameters
125131
126132- `ca_certificate_pem: string`
from line 212
206212
207213- `tunnel_id: string`
208214
215 ID of the tunnel (`tnl_...`).
216
209217- `certificate_id: string`
210218
219 ID of the certificate (`tcrt_...`).
220
211221### Headers
212222
213223- `"anthropic-beta": optional array of AnthropicBeta`
from line 322
312322
313323- `"anthropic-workspace-id": optional string`
314324
325 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
326
327 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
328
315329### Returns
316330
317331- `BetaTunnelCertificate object`
from line 399
385399
386400- `tunnel_id: string`
387401
402 ID of the tunnel (`tnl_...`).
403
388404### Query parameters
389405
390406- `include_archived: optional boolean`
from line 521
505521
506522- `"anthropic-workspace-id": optional string`
507523
524 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
525
526 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
527
508528### Returns
509529
510530- `data: array of BetaTunnelCertificate`
from line 607
587607
588608- `tunnel_id: string`
589609
610 ID of the tunnel (`tnl_...`).
611
590612- `certificate_id: string`
591613
614 ID of the certificate to archive (`tcrt_...`).
615
592616### Headers
593617
594618- `"anthropic-beta": optional array of AnthropicBeta`
from line 716
692716 - `"compact-2026-09-04"`
693717
694718- `"anthropic-workspace-id": optional string`
719
720 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
721
722 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
695723
696724### Returns
697725
api/beta/tunnels/certificates/archive Changed · +8 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820- `certificate_id: string`
1921
22 ID of the certificate to archive (`tcrt_...`).
23
2024## Headers
2125
2226- `"anthropic-beta": optional array of AnthropicBeta`
from line 124
120124 - `"compact-2026-09-04"`
121125
122126- `"anthropic-workspace-id": optional string`
127
128 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
129
130 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123131
124132## Returns
125133
api/beta/tunnels/certificates/create Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Headers
1921
2022- `"anthropic-beta": optional array of AnthropicBeta`
from line 120
118120 - `"compact-2026-09-04"`
119121
120122- `"anthropic-workspace-id": optional string`
123
124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
125
126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121127
122128## Body parameters
123129
api/beta/tunnels/certificates/list Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Query parameters
1921
2022- `include_archived: optional boolean`
from line 136
134136 - `"compact-2026-09-04"`
135137
136138- `"anthropic-workspace-id": optional string`
139
140 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
141
142 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
137143
138144## Returns
139145
api/beta/tunnels/certificates/retrieve Changed · +8 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820- `certificate_id: string`
1921
22 ID of the certificate (`tcrt_...`).
23
2024## Headers
2125
2226- `"anthropic-beta": optional array of AnthropicBeta`
from line 124
120124 - `"compact-2026-09-04"`
121125
122126- `"anthropic-workspace-id": optional string`
127
128 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
129
130 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
123131
124132## Returns
125133
api/beta/tunnels/retrieve Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Headers
1921
2022- `"anthropic-beta": optional array of AnthropicBeta`
from line 120
118120 - `"compact-2026-09-04"`
119121
120122- `"anthropic-workspace-id": optional string`
123
124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
125
126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121127
122128## Returns
123129
api/beta/tunnels/reveal_token Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Headers
1921
2022- `"anthropic-beta": optional array of AnthropicBeta`
from line 120
118120 - `"compact-2026-09-04"`
119121
120122- `"anthropic-workspace-id": optional string`
123
124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
125
126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121127
122128## Returns
123129
api/beta/tunnels/rotate_token Changed · +6 / -0 lines
from line 15
1515
1616- `tunnel_id: string`
1717
18 ID of the tunnel (`tnl_...`).
19
1820## Headers
1921
2022- `"anthropic-beta": optional array of AnthropicBeta`
from line 120
118120 - `"compact-2026-09-04"`
119121
120122- `"anthropic-workspace-id": optional string`
123
124 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
125
126 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121127
122128## Body parameters
123129
api/beta/user_profiles Changed · +144 / -4 lines
from line 115
115115
116116- `"anthropic-workspace-id": optional string`
117117
118 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
119
120 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
121
118122### Body parameters
119123
120124- `access_type: optional "application" or "passthrough"`
from line 127
123127
124128 - `"application"`
125129
130 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
131
126132 - `"passthrough"`
127133
134 The user profile represents a company that the platform resells Claude access to.
135
128136- `external_id: optional string or null`
129137
130138 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
from line 149
141149
142150 - `"active"`
143151
152 The platform has neither restricted nor barred the account of the entity that the user profile represents.
153
144154 - `"suspended"`
145155
156 The platform has restricted the account of the entity that the user profile represents and may restore it.
157
146158 - `"blocked"`
147159
160 The platform has barred the account of the entity that the user profile represents.
161
148162 - `country: optional string or null`
149163
150164 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 219
205219
206220- `BetaUserProfile object`
207221
222 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
223
224 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
225
208226 - `type: "user_profile"`
209227
210228 Object type. Always `user_profile`.
from line 267
249267
250268 - `"application"`
251269
270 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
271
252272 - `"passthrough"`
253273
274 The user profile represents a company that the platform resells Claude access to.
275
254276 - `external_id: optional string or null`
255277
256278 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 287
265287
266288 - `"active"`
267289
290 The platform has neither restricted nor barred the account of the entity that the user profile represents.
291
268292 - `"suspended"`
269293
294 The platform has restricted the account of the entity that the user profile represents and may restore it.
295
270296 - `"blocked"`
271297
298 The platform has barred the account of the entity that the user profile represents.
299
272300 - `country: string or null`
273301
274302 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 396
368396
369397- `limit: optional number`
370398
371 Query parameter for limit
399 The maximum number of user profiles to return, from 1 to 100. Defaults to 20.
372400
373401 format: int32
374402
375403- `order: optional "asc" or "desc"`
376404
377 Query parameter for order
405 The sort direction, applied to the field that `order_by` selects. Defaults to `desc`.
378406
379407 - `"asc"`
380408
409 Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`.
410
381411 - `"desc"`
382412
413 Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default.
414
383415- `order_by: optional "created_at" or "name"`
384416
385 Query parameter for order_by
417 The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`.
386418
387419 - `"created_at"`
388420
421 Sort by when each user profile was created. This is the default.
422
389423 - `"name"`
390424
425 Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction.
426
391427- `page: optional string`
392428
393 Query parameter for page
429 The cursor for the page to return, taken from `next_page` in a previous response.
394430
431 Leave it out to get the first page.
432
395433### Headers
396434
397435- `"anthropic-beta": optional array of AnthropicBeta`
from line 534
496534
497535- `"anthropic-workspace-id": optional string`
498536
537 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
538
539 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
540
499541### Returns
500542
501543- `data: array of BetaUserProfile`
from line 588
546588
547589 - `"application"`
548590
591 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
592
549593 - `"passthrough"`
550594
595 The user profile represents a company that the platform resells Claude access to.
596
551597 - `external_id: optional string or null`
552598
553599 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 608
562608
563609 - `"active"`
564610
611 The platform has neither restricted nor barred the account of the entity that the user profile represents.
612
565613 - `"suspended"`
566614
615 The platform has restricted the account of the entity that the user profile represents and may restore it.
616
567617 - `"blocked"`
568618
619 The platform has barred the account of the entity that the user profile represents.
620
569621 - `country: string or null`
570622
571623 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 720
668720
669721- `user_profile_id: string`
670722
723 The ID of the user profile to get (`uprof_...`).
724
671725### Headers
672726
673727- `"anthropic-beta": optional array of AnthropicBeta`
from line 826
772826
773827- `"anthropic-workspace-id": optional string`
774828
829 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
830
831 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
832
775833### Returns
776834
777835- `BetaUserProfile object`
778836
837 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
838
839 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
840
779841 - `type: "user_profile"`
780842
781843 Object type. Always `user_profile`.
from line 882
820882
821883 - `"application"`
822884
885 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
886
823887 - `"passthrough"`
824888
889 The user profile represents a company that the platform resells Claude access to.
890
825891 - `external_id: optional string or null`
826892
827893 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 902
836902
837903 - `"active"`
838904
905 The platform has neither restricted nor barred the account of the entity that the user profile represents.
906
839907 - `"suspended"`
840908
909 The platform has restricted the account of the entity that the user profile represents and may restore it.
910
841911 - `"blocked"`
842912
913 The platform has barred the account of the entity that the user profile represents.
914
843915 - `country: string or null`
844916
845917 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1005
9331005
9341006- `user_profile_id: string`
9351007
1008 The ID of the user profile to update (`uprof_...`).
1009
9361010### Headers
9371011
9381012- `"anthropic-beta": optional array of AnthropicBeta`
from line 1111
10371111
10381112- `"anthropic-workspace-id": optional string`
10391113
1114 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1115
1116 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1117
10401118### Body parameters
10411119
10421120- `access_type: optional "application" or "passthrough" or null`
from line 1123
10451123
10461124 - `"application"`
10471125
1126 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
1127
10481128 - `"passthrough"`
10491129
1130 The user profile represents a company that the platform resells Claude access to.
1131
10501132- `external_id: optional string or null`
10511133
10521134 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
from line 1145
10631145
10641146 - `"active"`
10651147
1148 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1149
10661150 - `"suspended"`
10671151
1152 The platform has restricted the account of the entity that the user profile represents and may restore it.
1153
10681154 - `"blocked"`
10691155
1156 The platform has barred the account of the entity that the user profile represents.
1157
10701158 - `country: optional string or null`
10711159
10721160 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 1215
11271215
11281216- `BetaUserProfile object`
11291217
1218 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
1219
1220 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
1221
11301222 - `type: "user_profile"`
11311223
11321224 Object type. Always `user_profile`.
from line 1263
11711263
11721264 - `"application"`
11731265
1266 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
1267
11741268 - `"passthrough"`
11751269
1270 The user profile represents a company that the platform resells Claude access to.
1271
11761272 - `external_id: optional string or null`
11771273
11781274 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 1283
11871283
11881284 - `"active"`
11891285
1286 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1287
11901288 - `"suspended"`
11911289
1290 The platform has restricted the account of the entity that the user profile represents and may restore it.
1291
11921292 - `"blocked"`
11931293
1294 The platform has barred the account of the entity that the user profile represents.
1295
11941296 - `country: string or null`
11951297
11961298 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1390
12881390
12891391- `user_profile_id: string`
12901392
1393 The ID of the user profile to create an enrollment URL for (`uprof_...`).
1394
12911395### Headers
12921396
12931397- `"anthropic-beta": optional array of AnthropicBeta`
from line 1496
13921496
13931497- `"anthropic-workspace-id": optional string`
13941498
1499 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
1500
1501 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
1502
13951503### Returns
13961504
13971505- `BetaUserProfileEnrollmentURL object`
13981506
1507 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1508
13991509 - `type: "enrollment_url"`
14001510
14011511 Object type. Always `enrollment_url`.
from line 1546
14361546
14371547- `BetaUserProfile object`
14381548
1549 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
1550
1551 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
1552
14391553 - `type: "user_profile"`
14401554
14411555 Object type. Always `user_profile`.
from line 1594
14801594
14811595 - `"application"`
14821596
1597 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
1598
14831599 - `"passthrough"`
14841600
1601 The user profile represents a company that the platform resells Claude access to.
1602
14851603 - `external_id: optional string or null`
14861604
14871605 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 1614
14961614
14971615 - `"active"`
14981616
1617 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1618
14991619 - `"suspended"`
15001620
1621 The platform has restricted the account of the entity that the user profile represents and may restore it.
1622
15011623 - `"blocked"`
15021624
1625 The platform has barred the account of the entity that the user profile represents.
1626
15031627 - `country: string or null`
15041628
15051629 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1672
15481672
15491673- `BetaUserProfileEnrollmentURL object`
15501674
1675 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
1676
15511677 - `type: "enrollment_url"`
15521678
15531679 Object type. Always `enrollment_url`.
from line 1700
15741700
15751701 - `"active"`
15761702
1703 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1704
15771705 - `"suspended"`
15781706
1707 The platform has restricted the account of the entity that the user profile represents and may restore it.
1708
15791709 - `"blocked"`
15801710
1711 The platform has barred the account of the entity that the user profile represents.
1712
15811713 - `country: string or null`
15821714
15831715 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
from line 1754
16221754
16231755 - `"active"`
16241756
1757 The platform has neither restricted nor barred the account of the entity that the user profile represents.
1758
16251759 - `"suspended"`
16261760
1761 The platform has restricted the account of the entity that the user profile represents and may restore it.
1762
16271763 - `"blocked"`
16281764
1765 The platform has barred the account of the entity that the user profile represents.
1766
16291767 - `country: optional string or null`
16301768
16311769 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 1807
16691807### Beta User Profile Trust Grant
16701808
16711809- `BetaUserProfileTrustGrant object`
1810
1811 The status of one trust grant on a user profile, listed in the profile's `trust_grants` map under the grant's name.
16721812
16731813 - `status: "active" or "pending" or "rejected"`
16741814
api/beta/user_profiles/create Changed · +28 / -0 lines
from line 113
113113
114114- `"anthropic-workspace-id": optional string`
115115
116 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
117
118 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
119
116120## Body parameters
117121
118122- `access_type: optional "application" or "passthrough"`
from line 125
121125
122126 - `"application"`
123127
128 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
129
124130 - `"passthrough"`
125131
132 The user profile represents a company that the platform resells Claude access to.
133
126134- `external_id: optional string or null`
127135
128136 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead.
from line 147
139147
140148 - `"active"`
141149
150 The platform has neither restricted nor barred the account of the entity that the user profile represents.
151
142152 - `"suspended"`
143153
154 The platform has restricted the account of the entity that the user profile represents and may restore it.
155
144156 - `"blocked"`
145157
158 The platform has barred the account of the entity that the user profile represents.
159
146160 - `country: optional string or null`
147161
148162 The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked.
from line 217
203217
204218- `BetaUserProfile object`
205219
220 A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to.
221
222 A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity.
223
206224 - `type: "user_profile"`
207225
208226 Object type. Always `user_profile`.
from line 265
247265
248266 - `"application"`
249267
268 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
269
250270 - `"passthrough"`
251271
272 The user profile represents a company that the platform resells Claude access to.
273
252274 - `external_id: optional string or null`
253275
254276 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 285
263285
264286 - `"active"`
265287
288 The platform has neither restricted nor barred the account of the entity that the user profile represents.
289
266290 - `"suspended"`
267291
292 The platform has restricted the account of the entity that the user profile represents and may restore it.
293
268294 - `"blocked"`
295
296 The platform has barred the account of the entity that the user profile represents.
269297
270298 - `country: string or null`
271299
api/beta/user_profiles/create_enrollment_url Changed · +8 / -0 lines
from line 13
1313
1414- `user_profile_id: string`
1515
16 The ID of the user profile to create an enrollment URL for (`uprof_...`).
17
1618## Headers
1719
1820- `"anthropic-beta": optional array of AnthropicBeta`
from line 119
117119
118120- `"anthropic-workspace-id": optional string`
119121
122 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
123
124 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
125
120126## Returns
121127
122128- `BetaUserProfileEnrollmentURL object`
129
130 A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.
123131
124132 - `type: "enrollment_url"`
125133
api/beta/user_profiles/list Changed · +28 / -4 lines
from line 13
1313
1414- `limit: optional number`
1515
16 Query parameter for limit
16 The maximum number of user profiles to return, from 1 to 100. Defaults to 20.
1717
1818 format: int32
1919
2020- `order: optional "asc" or "desc"`
2121
22 Query parameter for order
22 The sort direction, applied to the field that `order_by` selects. Defaults to `desc`.
2323
2424 - `"asc"`
2525
26 Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`.
27
2628 - `"desc"`
2729
30 Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default.
31
2832- `order_by: optional "created_at" or "name"`
2933
30 Query parameter for order_by
34 The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`.
3135
3236 - `"created_at"`
3337
38 Sort by when each user profile was created. This is the default.
39
3440 - `"name"`
3541
42 Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction.
43
3644- `page: optional string`
3745
38 Query parameter for page
46 The cursor for the page to return, taken from `next_page` in a previous response.
3947
48 Leave it out to get the first page.
49
4050## Headers
4151
4252- `"anthropic-beta": optional array of AnthropicBeta`
from line 151
141151
142152- `"anthropic-workspace-id": optional string`
143153
154 Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
155
156 Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.
157
144158## Returns
145159
146160- `data: array of BetaUserProfile`
from line 205
191205
192206 - `"application"`
193207
208 The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default.
209
194210 - `"passthrough"`
195211
212 The user profile represents a company that the platform resells Claude access to.
213
196214 - `external_id: optional string or null`
197215
198216 Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`.
from line 225
207225
208226 - `"active"`
209227
228 The platform has neither restricted nor barred the account of the entity that the user profile represents.
229
210230 - `"suspended"`
211231
232 The platform has restricted the account of the entity that the user profile represents and may restore it.
233
212234 - `"blocked"`
235
236 The platform has barred the account of the entity that the user profile represents.
213237
214238 - `country: string or null`
215239