What this read moved
376–400 of 519This capture is too large to show at once. Changes 376-400 of 519 are below, significant first; the rest are on the following screens.
api/beta/skills/list Changed · +18 / -9 lines
from line 1
1---
2title: List Skills
3url: https://platform.claude.com/docs/en/api/beta/skills/list
4---
5
16# List Skills
27
38**GET** `/v1/skills`
from line 42
3742
3843 - `string`
3944
40 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
45 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
4146
4247 - `"message-batches-2024-09-24"`
4348
from line 90
8590
8691 - `"user-profiles-2026-08-18"`
8792
93 - `"user-profiles-2026-09-04"`
94
8895 - `"advisor-tool-2026-03-01"`
8996
9097 - `"managed-agents-2026-04-01"`
from line 134
127134
128135 - `"mid-conversation-system-clear-at-2026-08-21"`
129136
137- `"anthropic-workspace-id": optional string`
138
130139## Returns
131140
132141- `data: array of BetaSkill`
from line 142
133142
134143 List of skills.
135144
145 - `type: "skill"`
146
147 Object type.
148
149 For Skills, this is always `"skill"`.
150
151 default: skill
152
136153 - `id: string`
137154
138155 Unique identifier for the skill.
from line 201
184201 - `"anthropic_example"`
185202
186203 - `"plugin"`
187
188 - `type: "skill"`
189
190 Object type.
191
192 For Skills, this is always `"skill"`.
193
194 default: skill
195204
196205 - `updated_at: string`
197206
api/beta/skills/retrieve Changed · +18 / -9 lines
from line 1
1---
2title: Get Skill
3url: https://platform.claude.com/docs/en/api/beta/skills/retrieve
4---
5
16# Get Skill
27
38**GET** `/v1/skills/{skill_id}`
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122## Returns
114123
115124- `BetaSkill object`
116125
126 - `type: "skill"`
127
128 Object type.
129
130 For Skills, this is always `"skill"`.
131
132 default: skill
133
117134 - `id: string`
118135
119136 Unique identifier for the skill.
from line 182
165182 - `"anthropic_example"`
166183
167184 - `"plugin"`
168
169 - `type: "skill"`
170
171 Object type.
172
173 For Skills, this is always `"skill"`.
174
175 default: skill
176185
177186 - `updated_at: string`
178187
api/beta/skills/versions Changed · +78 / -53 lines
from line 1
1---
2title: Versions
3url: https://platform.claude.com/docs/en/api/beta/skills/versions
4---
5
16# Versions
27
38## Create Skill Version
from line 27
2227
2328 - `string`
2429
25 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
30 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2631
2732 - `"message-batches-2024-09-24"`
2833
from line 75
7075
7176 - `"user-profiles-2026-08-18"`
7277
78 - `"user-profiles-2026-09-04"`
79
7380 - `"advisor-tool-2026-03-01"`
7481
7582 - `"managed-agents-2026-04-01"`
from line 119
112119
113120 - `"mid-conversation-system-clear-at-2026-08-21"`
114121
122- `"anthropic-workspace-id": optional string`
123
115124### Body parameters (form-data)
116125
117126- `files: array of string`
from line 133
124133
125134- `BetaSkillVersion object`
126135
136 - `type: "skill_version"`
137
138 Object type.
139
140 For Skill Versions, this is always `"skill_version"`.
141
142 default: skill_version
143
127144 - `id: string`
128145
129146 Unique identifier for this Skill Version. The id addresses the version in
from line 171
154171
155172 The format and length of IDs may change over time.
156173
157 - `type: "skill_version"`
158
159 Object type.
160
161 For Skill Versions, this is always `"skill_version"`.
162
163 default: skill_version
164
165174### Example
166175
167176```bash
from line 230
221230
222231 - `string`
223232
224 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
233 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
225234
226235 - `"message-batches-2024-09-24"`
227236
from line 278
269278
270279 - `"user-profiles-2026-08-18"`
271280
281 - `"user-profiles-2026-09-04"`
282
272283 - `"advisor-tool-2026-03-01"`
273284
274285 - `"managed-agents-2026-04-01"`
from line 322
311322
312323 - `"mid-conversation-system-clear-at-2026-08-21"`
313324
325- `"anthropic-workspace-id": optional string`
326
314327### Returns
315328
316329- `data: array of BetaSkillVersion`
from line 330
317330
318331 List of skills.
319332
333 - `type: "skill_version"`
334
335 Object type.
336
337 For Skill Versions, this is always `"skill_version"`.
338
339 default: skill_version
340
320341 - `id: string`
321342
322343 Unique identifier for this Skill Version. The id addresses the version in
from line 368
347368
348369 The format and length of IDs may change over time.
349370
350 - `type: "skill_version"`
351
352 Object type.
353
354 For Skill Versions, this is always `"skill_version"`.
355
356 default: skill_version
357
358371- `next_page: string or null`
359372
360373 Token for fetching the next page of results.
from line 428
415428
416429 - `string`
417430
418 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
431 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
419432
420433 - `"message-batches-2024-09-24"`
421434
from line 476
463476
464477 - `"user-profiles-2026-08-18"`
465478
479 - `"user-profiles-2026-09-04"`
480
466481 - `"advisor-tool-2026-03-01"`
467482
468483 - `"managed-agents-2026-04-01"`
from line 520
505520
506521 - `"mid-conversation-system-clear-at-2026-08-21"`
507522
523- `"anthropic-workspace-id": optional string`
524
508525### Example
509526
510527```bash
from line 558
541558
542559 - `string`
543560
544 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
561 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
545562
546563 - `"message-batches-2024-09-24"`
547564
from line 606
589606
590607 - `"user-profiles-2026-08-18"`
591608
609 - `"user-profiles-2026-09-04"`
610
592611 - `"advisor-tool-2026-03-01"`
593612
594613 - `"managed-agents-2026-04-01"`
from line 650
631650
632651 - `"mid-conversation-system-clear-at-2026-08-21"`
633652
653- `"anthropic-workspace-id": optional string`
654
634655### Returns
635656
636657- `BetaSkillVersion object`
637658
659 - `type: "skill_version"`
660
661 Object type.
662
663 For Skill Versions, this is always `"skill_version"`.
664
665 default: skill_version
666
638667 - `id: string`
639668
640669 Unique identifier for this Skill Version. The id addresses the version in
from line 694
665694
666695 The format and length of IDs may change over time.
667696
668 - `type: "skill_version"`
669
670 Object type.
671
672 For Skill Versions, this is always `"skill_version"`.
673
674 default: skill_version
675
676697### Example
677698
678699```bash
from line 743
722743
723744 - `string`
724745
725 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
746 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
726747
727748 - `"message-batches-2024-09-24"`
728749
from line 791
770791
771792 - `"user-profiles-2026-08-18"`
772793
794 - `"user-profiles-2026-09-04"`
795
773796 - `"advisor-tool-2026-03-01"`
774797
775798 - `"managed-agents-2026-04-01"`
from line 835
812835
813836 - `"mid-conversation-system-clear-at-2026-08-21"`
814837
838- `"anthropic-workspace-id": optional string`
839
815840### Returns
816841
817842- `BetaDeletedSkillVersion object`
818843
819 - `id: string`
820
821 Unique identifier for this Skill Version. The id addresses the version in
822 paths and pins it in references.
823
824844 - `type: "skill_version_deleted"`
825845
826846 Deleted object type.
from line 849
829849
830850 default: skill_version_deleted
831851
852 - `id: string`
853
854 Unique identifier for this Skill Version. The id addresses the version in
855 paths and pins it in references.
856
832857### Example
833858
834859```bash
from line 878
853878
854879- `BetaDeletedSkillVersion object`
855880
856 - `id: string`
857
858 Unique identifier for this Skill Version. The id addresses the version in
859 paths and pins it in references.
860
861881 - `type: "skill_version_deleted"`
862882
863883 Deleted object type.
from line 886
866886
867887 default: skill_version_deleted
868888
889 - `id: string`
890
891 Unique identifier for this Skill Version. The id addresses the version in
892 paths and pins it in references.
893
869894### Beta Skill Version
870895
871896- `BetaSkillVersion object`
872897
898 - `type: "skill_version"`
899
900 Object type.
901
902 For Skill Versions, this is always `"skill_version"`.
903
904 default: skill_version
905
873906 - `id: string`
874907
875908 Unique identifier for this Skill Version. The id addresses the version in
from line 932
899932 Unique identifier for the skill.
900933
901934 The format and length of IDs may change over time.
902
903 - `type: "skill_version"`
904
905 Object type.
906
907 For Skill Versions, this is always `"skill_version"`.
908
909 default: skill_version
910935
api/beta/skills/versions/create Changed · +18 / -9 lines
from line 1
1---
2title: Create Skill Version
3url: https://platform.claude.com/docs/en/api/beta/skills/versions/create
4---
5
16# Create Skill Version
27
38**POST** `/v1/skills/{skill_id}/versions`
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122## Body parameters (form-data)
114123
115124- `files: array of string`
from line 131
122131
123132- `BetaSkillVersion object`
124133
134 - `type: "skill_version"`
135
136 Object type.
137
138 For Skill Versions, this is always `"skill_version"`.
139
140 default: skill_version
141
125142 - `id: string`
126143
127144 Unique identifier for this Skill Version. The id addresses the version in
from line 168
151168 Unique identifier for the skill.
152169
153170 The format and length of IDs may change over time.
154
155 - `type: "skill_version"`
156
157 Object type.
158
159 For Skill Versions, this is always `"skill_version"`.
160
161 default: skill_version
162171
163172## Example
164173
api/beta/skills/versions/delete Changed · +15 / -6 lines
from line 1
1---
2title: Delete Skill Version
3url: https://platform.claude.com/docs/en/api/beta/skills/versions/delete
4---
5
16# Delete Skill Version
27
38**DELETE** `/v1/skills/{skill_id}/versions/{version}`
from line 31
2631
2732 - `string`
2833
29 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3035
3136 - `"message-batches-2024-09-24"`
3237
from line 79
7479
7580 - `"user-profiles-2026-08-18"`
7681
82 - `"user-profiles-2026-09-04"`
83
7784 - `"advisor-tool-2026-03-01"`
7885
7986 - `"managed-agents-2026-04-01"`
from line 123
116123
117124 - `"mid-conversation-system-clear-at-2026-08-21"`
118125
126- `"anthropic-workspace-id": optional string`
127
119128## Returns
120129
121130- `BetaDeletedSkillVersion object`
122131
123 - `id: string`
124
125 Unique identifier for this Skill Version. The id addresses the version in
126 paths and pins it in references.
127
128132 - `type: "skill_version_deleted"`
129133
130134 Deleted object type.
from line 136
132136 For Skill Versions, this is always `"skill_version_deleted"`.
133137
134138 default: skill_version_deleted
139
140 - `id: string`
141
142 Unique identifier for this Skill Version. The id addresses the version in
143 paths and pins it in references.
135144
136145## Example
137146
api/beta/skills/versions/download Changed · +10 / -1 lines
from line 1
1---
2title: Download Skill Version Content
3url: https://platform.claude.com/docs/en/api/beta/skills/versions/download
4---
5
16# Download Skill Version Content
27
38**GET** `/v1/skills/{skill_id}/versions/{version}/content`
from line 31
2631
2732 - `string`
2833
29 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3035
3136 - `"message-batches-2024-09-24"`
3237
from line 79
7479
7580 - `"user-profiles-2026-08-18"`
7681
82 - `"user-profiles-2026-09-04"`
83
7784 - `"advisor-tool-2026-03-01"`
7885
7986 - `"managed-agents-2026-04-01"`
from line 122
115122 - `"thinking-binding-controls-2026-08-01"`
116123
117124 - `"mid-conversation-system-clear-at-2026-08-21"`
125
126- `"anthropic-workspace-id": optional string`
118127
119128## Example
120129
api/beta/skills/versions/list Changed · +18 / -9 lines
from line 1
1---
2title: List Skill Versions
3url: https://platform.claude.com/docs/en/api/beta/skills/versions/list
4---
5
16# List Skill Versions
27
38**GET** `/v1/skills/{skill_id}/versions`
from line 39
3439
3540 - `string`
3641
37 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3843
3944 - `"message-batches-2024-09-24"`
4045
from line 87
8287
8388 - `"user-profiles-2026-08-18"`
8489
90 - `"user-profiles-2026-09-04"`
91
8592 - `"advisor-tool-2026-03-01"`
8693
8794 - `"managed-agents-2026-04-01"`
from line 131
124131
125132 - `"mid-conversation-system-clear-at-2026-08-21"`
126133
134- `"anthropic-workspace-id": optional string`
135
127136## Returns
128137
129138- `data: array of BetaSkillVersion`
from line 139
130139
131140 List of skills.
132141
142 - `type: "skill_version"`
143
144 Object type.
145
146 For Skill Versions, this is always `"skill_version"`.
147
148 default: skill_version
149
133150 - `id: string`
134151
135152 Unique identifier for this Skill Version. The id addresses the version in
from line 176
159176 Unique identifier for the skill.
160177
161178 The format and length of IDs may change over time.
162
163 - `type: "skill_version"`
164
165 Object type.
166
167 For Skill Versions, this is always `"skill_version"`.
168
169 default: skill_version
170179
171180- `next_page: string or null`
172181
api/beta/skills/versions/retrieve Changed · +18 / -9 lines
from line 1
1---
2title: Get Skill Version
3url: https://platform.claude.com/docs/en/api/beta/skills/versions/retrieve
4---
5
16# Get Skill Version
27
38**GET** `/v1/skills/{skill_id}/versions/{version}`
from line 31
2631
2732 - `string`
2833
29 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
34 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3035
3136 - `"message-batches-2024-09-24"`
3237
from line 79
7479
7580 - `"user-profiles-2026-08-18"`
7681
82 - `"user-profiles-2026-09-04"`
83
7784 - `"advisor-tool-2026-03-01"`
7885
7986 - `"managed-agents-2026-04-01"`
from line 123
116123
117124 - `"mid-conversation-system-clear-at-2026-08-21"`
118125
126- `"anthropic-workspace-id": optional string`
127
119128## Returns
120129
121130- `BetaSkillVersion object`
122131
132 - `type: "skill_version"`
133
134 Object type.
135
136 For Skill Versions, this is always `"skill_version"`.
137
138 default: skill_version
139
123140 - `id: string`
124141
125142 Unique identifier for this Skill Version. The id addresses the version in
from line 166
149166 Unique identifier for the skill.
150167
151168 The format and length of IDs may change over time.
152
153 - `type: "skill_version"`
154
155 Object type.
156
157 For Skill Versions, this is always `"skill_version"`.
158
159 default: skill_version
160169
161170## Example
162171
api/beta/tunnels Changed · +79 / -34 lines
from line 1
1---
2title: Tunnels
3url: https://platform.claude.com/docs/en/api/beta/tunnels
4---
5
16# Tunnels
27
38## Create Tunnel
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 113
106113
107114 - `"mid-conversation-system-clear-at-2026-08-21"`
108115
116- `"anthropic-workspace-id": optional string`
117
109118### Body parameters
110119
111120- `display_name: optional string or null`
from line 129
120129
121130 An MCP tunnel.
122131
132 - `type: "tunnel"`
133
123134 - `id: string`
124135
125136 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 155
144155
145156 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
146157
147 - `type: "tunnel"`
148
149158### Example
150159
151160```bash
from line 199
190199
191200 - `string`
192201
193 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
202 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
194203
195204 - `"message-batches-2024-09-24"`
196205
from line 247
238247
239248 - `"user-profiles-2026-08-18"`
240249
250 - `"user-profiles-2026-09-04"`
251
241252 - `"advisor-tool-2026-03-01"`
242253
243254 - `"managed-agents-2026-04-01"`
from line 291
280291
281292 - `"mid-conversation-system-clear-at-2026-08-21"`
282293
294- `"anthropic-workspace-id": optional string`
295
283296### Returns
284297
285298- `BetaTunnel object`
from line 299
286299
287300 An MCP tunnel.
288301
302 - `type: "tunnel"`
303
289304 - `id: string`
290305
291306 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 325
310325
311326 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
312327
313 - `type: "tunnel"`
314
315328### Example
316329
317330```bash
from line 379
366379
367380 - `string`
368381
369 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
382 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
370383
371384 - `"message-batches-2024-09-24"`
372385
from line 427
414427
415428 - `"user-profiles-2026-08-18"`
416429
430 - `"user-profiles-2026-09-04"`
431
417432 - `"advisor-tool-2026-03-01"`
418433
419434 - `"managed-agents-2026-04-01"`
from line 471
456471
457472 - `"mid-conversation-system-clear-at-2026-08-21"`
458473
474- `"anthropic-workspace-id": optional string`
475
459476### Returns
460477
461478- `data: array of BetaTunnel`
from line 479
462479
463480 List of tunnels, ordered by created_at descending.
464481
482 - `type: "tunnel"`
483
465484 - `id: string`
466485
467486 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 505
486505
487506 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
488507
489 - `type: "tunnel"`
490
491508- `next_page: string or null`
492509
493510 Pagination cursor for the next page, or null if no more results.
from line 556
539556
540557 - `string`
541558
542 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
559 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
543560
544561 - `"message-batches-2024-09-24"`
545562
from line 604
587604
588605 - `"user-profiles-2026-08-18"`
589606
607 - `"user-profiles-2026-09-04"`
608
590609 - `"advisor-tool-2026-03-01"`
591610
592611 - `"managed-agents-2026-04-01"`
from line 648
629648
630649 - `"mid-conversation-system-clear-at-2026-08-21"`
631650
651- `"anthropic-workspace-id": optional string`
652
632653### Returns
633654
634655- `BetaTunnel object`
from line 656
635656
636657 An MCP tunnel.
637658
659 - `type: "tunnel"`
660
638661 - `id: string`
639662
640663 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 682
659682
660683 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
661684
662 - `type: "tunnel"`
663
664685### Example
665686
666687```bash
from line 725
704725
705726 - `string`
706727
707 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
728 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
708729
709730 - `"message-batches-2024-09-24"`
710731
from line 773
752773
753774 - `"user-profiles-2026-08-18"`
754775
776 - `"user-profiles-2026-09-04"`
777
755778 - `"advisor-tool-2026-03-01"`
756779
757780 - `"managed-agents-2026-04-01"`
from line 817
794817
795818 - `"mid-conversation-system-clear-at-2026-08-21"`
796819
820- `"anthropic-workspace-id": optional string`
821
797822### Returns
798823
799824- `BetaTunnelToken object`
from line 825
800825
801826 A tunnel's connector token.
802827
828 - `type: "tunnel_token"`
829
803830 - `id: string`
804831
805832 Stable identifier for the current token value. Changes when the token is rotated.
from line 835
808835
809836 The connector token used to run the tunnel. Treat as a credential.
810837
811 - `type: "tunnel_token"`
812
813838### Example
814839
815840```bash
from line 875
850875
851876 - `string`
852877
853 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
878 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
854879
855880 - `"message-batches-2024-09-24"`
856881
from line 923
898923
899924 - `"user-profiles-2026-08-18"`
900925
926 - `"user-profiles-2026-09-04"`
927
901928 - `"advisor-tool-2026-03-01"`
902929
903930 - `"managed-agents-2026-04-01"`
from line 967
940967
941968 - `"mid-conversation-system-clear-at-2026-08-21"`
942969
970- `"anthropic-workspace-id": optional string`
971
943972### Body parameters
944973
945974- `reason: optional string or null`
from line 983
954983
955984 A tunnel's connector token.
956985
986 - `type: "tunnel_token"`
987
957988 - `id: string`
958989
959990 Stable identifier for the current token value. Changes when the token is rotated.
from line 993
962993
963994 The connector token used to run the tunnel. Treat as a credential.
964995
965 - `type: "tunnel_token"`
966
967996### Example
968997
969998```bash
from line 1022
9931022
9941023 An MCP tunnel.
9951024
1025 - `type: "tunnel"`
1026
9961027 - `id: string`
9971028
9981029 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 1048
10171048
10181049 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
10191050
1020 - `type: "tunnel"`
1021
10221051### Beta Tunnel Token
10231052
10241053- `BetaTunnelToken object`
from line 1054
10251054
10261055 A tunnel's connector token.
10271056
1057 - `type: "tunnel_token"`
1058
10281059 - `id: string`
10291060
10301061 Stable identifier for the current token value. Changes when the token is rotated.
from line 1064
10331064
10341065 The connector token used to run the tunnel. Treat as a credential.
10351066
1036 - `type: "tunnel_token"`
1037
10381067## Tunnels › Certificates
10391068
10401069### Create Tunnel Certificate
from line 1086
10571086
10581087 - `string`
10591088
1060 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1089 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
10611090
10621091 - `"message-batches-2024-09-24"`
10631092
from line 1134
11051134
11061135 - `"user-profiles-2026-08-18"`
11071136
1137 - `"user-profiles-2026-09-04"`
1138
11081139 - `"advisor-tool-2026-03-01"`
11091140
11101141 - `"managed-agents-2026-04-01"`
from line 1178
11471178
11481179 - `"mid-conversation-system-clear-at-2026-08-21"`
11491180
1181- `"anthropic-workspace-id": optional string`
1182
11501183#### Body parameters
11511184
11521185- `ca_certificate_pem: string`
from line 1194
11611194
11621195 A CA certificate attached to a tunnel.
11631196
1197 - `type: "tunnel_certificate"`
1198
11641199 - `id: string`
11651200
11661201 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1226
11911226
11921227 ID of the tunnel the certificate is registered against.
11931228
1194 - `type: "tunnel_certificate"`
1195
11961229#### Example
11971230
11981231```bash
from line 1275
12421275
12431276 - `string`
12441277
1245 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1278 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
12461279
12471280 - `"message-batches-2024-09-24"`
12481281
from line 1323
12901323
12911324 - `"user-profiles-2026-08-18"`
12921325
1326 - `"user-profiles-2026-09-04"`
1327
12931328 - `"advisor-tool-2026-03-01"`
12941329
12951330 - `"managed-agents-2026-04-01"`
from line 1367
13321367
13331368 - `"mid-conversation-system-clear-at-2026-08-21"`
13341369
1370- `"anthropic-workspace-id": optional string`
1371
13351372#### Returns
13361373
13371374- `BetaTunnelCertificate object`
from line 1375
13381375
13391376 A CA certificate attached to a tunnel.
13401377
1378 - `type: "tunnel_certificate"`
1379
13411380 - `id: string`
13421381
13431382 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1407
13681407
13691408 ID of the tunnel the certificate is registered against.
13701409
1371 - `type: "tunnel_certificate"`
1372
13731410#### Example
13741411
13751412```bash
from line 1466
14291466
14301467 - `string`
14311468
1432 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1469 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
14331470
14341471 - `"message-batches-2024-09-24"`
14351472
from line 1514
14771514
14781515 - `"user-profiles-2026-08-18"`
14791516
1517 - `"user-profiles-2026-09-04"`
1518
14801519 - `"advisor-tool-2026-03-01"`
14811520
14821521 - `"managed-agents-2026-04-01"`
from line 1558
15191558
15201559 - `"mid-conversation-system-clear-at-2026-08-21"`
15211560
1561- `"anthropic-workspace-id": optional string`
1562
15221563#### Returns
15231564
15241565- `data: array of BetaTunnelCertificate`
from line 1566
15251566
15261567 List of certificates, ordered by created_at descending.
15271568
1569 - `type: "tunnel_certificate"`
1570
15281571 - `id: string`
15291572
15301573 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1598
15551598
15561599 ID of the tunnel the certificate is registered against.
15571600
1558 - `type: "tunnel_certificate"`
1559
15601601- `next_page: string or null`
15611602
15621603 Pagination cursor for the next page, or null if no more results.
from line 1652
16111652
16121653 - `string`
16131654
1614 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1655 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
16151656
16161657 - `"message-batches-2024-09-24"`
16171658
from line 1700
16591700
16601701 - `"user-profiles-2026-08-18"`
16611702
1703 - `"user-profiles-2026-09-04"`
1704
16621705 - `"advisor-tool-2026-03-01"`
16631706
16641707 - `"managed-agents-2026-04-01"`
from line 1744
17011744
17021745 - `"mid-conversation-system-clear-at-2026-08-21"`
17031746
1747- `"anthropic-workspace-id": optional string`
1748
17041749#### Returns
17051750
17061751- `BetaTunnelCertificate object`
from line 1752
17071752
17081753 A CA certificate attached to a tunnel.
17091754
1755 - `type: "tunnel_certificate"`
1756
17101757 - `id: string`
17111758
17121759 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 1783
17361783 - `tunnel_id: string`
17371784
17381785 ID of the tunnel the certificate is registered against.
1739
1740 - `type: "tunnel_certificate"`
17411786
17421787#### Example
17431788
api/beta/tunnels/archive Changed · +12 / -3 lines
from line 1
1---
2title: Archive Tunnel
3url: https://platform.claude.com/docs/en/api/beta/tunnels/archive
4---
5
16# Archive Tunnel
27
38**POST** `/v1/tunnels/{tunnel_id}/archive`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaTunnel object`
from line 123
114123
115124 An MCP tunnel.
116125
126 - `type: "tunnel"`
127
117128 - `id: string`
118129
119130 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 148
137148 - `domain: string`
138149
139150 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
140
141 - `type: "tunnel"`
142151
143152## Example
144153
api/beta/tunnels/certificates Changed · +35 / -14 lines
from line 1
1---
2title: Certificates
3url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates
4---
5
16# Certificates
27
38## Create Tunnel Certificate
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122### Body parameters
114123
115124- `ca_certificate_pem: string`
from line 133
124133
125134 A CA certificate attached to a tunnel.
126135
136 - `type: "tunnel_certificate"`
137
127138 - `id: string`
128139
129140 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 165
154165
155166 ID of the tunnel the certificate is registered against.
156167
157 - `type: "tunnel_certificate"`
158
159168### Example
160169
161170```bash
from line 214
205214
206215 - `string`
207216
208 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
217 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
209218
210219 - `"message-batches-2024-09-24"`
211220
from line 262
253262
254263 - `"user-profiles-2026-08-18"`
255264
265 - `"user-profiles-2026-09-04"`
266
256267 - `"advisor-tool-2026-03-01"`
257268
258269 - `"managed-agents-2026-04-01"`
from line 306
295306
296307 - `"mid-conversation-system-clear-at-2026-08-21"`
297308
309- `"anthropic-workspace-id": optional string`
310
298311### Returns
299312
300313- `BetaTunnelCertificate object`
from line 314
301314
302315 A CA certificate attached to a tunnel.
303316
317 - `type: "tunnel_certificate"`
318
304319 - `id: string`
305320
306321 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 346
331346
332347 ID of the tunnel the certificate is registered against.
333348
334 - `type: "tunnel_certificate"`
335
336349### Example
337350
338351```bash
from line 405
392405
393406 - `string`
394407
395 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
408 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
396409
397410 - `"message-batches-2024-09-24"`
398411
from line 453
440453
441454 - `"user-profiles-2026-08-18"`
442455
456 - `"user-profiles-2026-09-04"`
457
443458 - `"advisor-tool-2026-03-01"`
444459
445460 - `"managed-agents-2026-04-01"`
from line 497
482497
483498 - `"mid-conversation-system-clear-at-2026-08-21"`
484499
500- `"anthropic-workspace-id": optional string`
501
485502### Returns
486503
487504- `data: array of BetaTunnelCertificate`
from line 505
488505
489506 List of certificates, ordered by created_at descending.
490507
508 - `type: "tunnel_certificate"`
509
491510 - `id: string`
492511
493512 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 537
518537
519538 ID of the tunnel the certificate is registered against.
520539
521 - `type: "tunnel_certificate"`
522
523540- `next_page: string or null`
524541
525542 Pagination cursor for the next page, or null if no more results.
from line 591
574591
575592 - `string`
576593
577 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
594 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
578595
579596 - `"message-batches-2024-09-24"`
580597
from line 639
622639
623640 - `"user-profiles-2026-08-18"`
624641
642 - `"user-profiles-2026-09-04"`
643
625644 - `"advisor-tool-2026-03-01"`
626645
627646 - `"managed-agents-2026-04-01"`
from line 683
664683
665684 - `"mid-conversation-system-clear-at-2026-08-21"`
666685
686- `"anthropic-workspace-id": optional string`
687
667688### Returns
668689
669690- `BetaTunnelCertificate object`
from line 691
670691
671692 A CA certificate attached to a tunnel.
672693
694 - `type: "tunnel_certificate"`
695
673696 - `id: string`
674697
675698 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 723
700723
701724 ID of the tunnel the certificate is registered against.
702725
703 - `type: "tunnel_certificate"`
704
705726### Example
706727
707728```bash
from line 755
734755
735756 A CA certificate attached to a tunnel.
736757
758 - `type: "tunnel_certificate"`
759
737760 - `id: string`
738761
739762 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 786
763786 - `tunnel_id: string`
764787
765788 ID of the tunnel the certificate is registered against.
766
767 - `type: "tunnel_certificate"`
768789
api/beta/tunnels/certificates/archive Changed · +12 / -3 lines
from line 1
1---
2title: Archive Tunnel Certificate
3url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/archive
4---
5
16# Archive Tunnel Certificate
27
38**POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive`
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122## Returns
114123
115124- `BetaTunnelCertificate object`
from line 125
116125
117126 A CA certificate attached to a tunnel.
118127
128 - `type: "tunnel_certificate"`
129
119130 - `id: string`
120131
121132 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 156
145156 - `tunnel_id: string`
146157
147158 ID of the tunnel the certificate is registered against.
148
149 - `type: "tunnel_certificate"`
150159
151160## Example
152161
api/beta/tunnels/certificates/create Changed · +12 / -3 lines
from line 1
1---
2title: Create Tunnel Certificate
3url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/create
4---
5
16# Create Tunnel Certificate
27
38**POST** `/v1/tunnels/{tunnel_id}/certificates`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Body parameters
112121
113122- `ca_certificate_pem: string`
from line 131
122131
123132 A CA certificate attached to a tunnel.
124133
134 - `type: "tunnel_certificate"`
135
125136 - `id: string`
126137
127138 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 162
151162 - `tunnel_id: string`
152163
153164 ID of the tunnel the certificate is registered against.
154
155 - `type: "tunnel_certificate"`
156165
157166## Example
158167
api/beta/tunnels/certificates/list Changed · +12 / -3 lines
from line 1
1---
2title: List Tunnel Certificates
3url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/list
4---
5
16# List Tunnel Certificates
27
38**GET** `/v1/tunnels/{tunnel_id}/certificates`
from line 39
3439
3540 - `string`
3641
37 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
42 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3843
3944 - `"message-batches-2024-09-24"`
4045
from line 87
8287
8388 - `"user-profiles-2026-08-18"`
8489
90 - `"user-profiles-2026-09-04"`
91
8592 - `"advisor-tool-2026-03-01"`
8693
8794 - `"managed-agents-2026-04-01"`
from line 131
124131
125132 - `"mid-conversation-system-clear-at-2026-08-21"`
126133
134- `"anthropic-workspace-id": optional string`
135
127136## Returns
128137
129138- `data: array of BetaTunnelCertificate`
from line 139
130139
131140 List of certificates, ordered by created_at descending.
132141
142 - `type: "tunnel_certificate"`
143
133144 - `id: string`
134145
135146 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 170
159170 - `tunnel_id: string`
160171
161172 ID of the tunnel the certificate is registered against.
162
163 - `type: "tunnel_certificate"`
164173
165174- `next_page: string or null`
166175
api/beta/tunnels/certificates/retrieve Changed · +12 / -3 lines
from line 1
1---
2title: Get Tunnel Certificate
3url: https://platform.claude.com/docs/en/api/beta/tunnels/certificates/retrieve
4---
5
16# Get Tunnel Certificate
27
38**GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}`
from line 25
2025
2126 - `string`
2227
23 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
28 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2429
2530 - `"message-batches-2024-09-24"`
2631
from line 73
6873
6974 - `"user-profiles-2026-08-18"`
7075
76 - `"user-profiles-2026-09-04"`
77
7178 - `"advisor-tool-2026-03-01"`
7279
7380 - `"managed-agents-2026-04-01"`
from line 117
110117
111118 - `"mid-conversation-system-clear-at-2026-08-21"`
112119
120- `"anthropic-workspace-id": optional string`
121
113122## Returns
114123
115124- `BetaTunnelCertificate object`
from line 125
116125
117126 A CA certificate attached to a tunnel.
118127
128 - `type: "tunnel_certificate"`
129
119130 - `id: string`
120131
121132 Unique identifier for the certificate, prefixed with `tcrt_`.
from line 156
145156 - `tunnel_id: string`
146157
147158 ID of the tunnel the certificate is registered against.
148
149 - `type: "tunnel_certificate"`
150159
151160## Example
152161
api/beta/tunnels/create Changed · +12 / -3 lines
from line 1
1---
2title: Create Tunnel
3url: https://platform.claude.com/docs/en/api/beta/tunnels/create
4---
5
16# Create Tunnel
27
38**POST** `/v1/tunnels`
from line 19
1419
1520 - `string`
1621
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1823
1924 - `"message-batches-2024-09-24"`
2025
from line 67
6267
6368 - `"user-profiles-2026-08-18"`
6469
70 - `"user-profiles-2026-09-04"`
71
6572 - `"advisor-tool-2026-03-01"`
6673
6774 - `"managed-agents-2026-04-01"`
from line 111
104111
105112 - `"mid-conversation-system-clear-at-2026-08-21"`
106113
114- `"anthropic-workspace-id": optional string`
115
107116## Body parameters
108117
109118- `display_name: optional string or null`
from line 127
118127
119128 An MCP tunnel.
120129
130 - `type: "tunnel"`
131
121132 - `id: string`
122133
123134 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 152
141152 - `domain: string`
142153
143154 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
144
145 - `type: "tunnel"`
146155
147156## Example
148157
api/beta/tunnels/list Changed · +12 / -3 lines
from line 1
1---
2title: List Tunnels
3url: https://platform.claude.com/docs/en/api/beta/tunnels/list
4---
5
16# List Tunnels
27
38**GET** `/v1/tunnels`
from line 35
3035
3136 - `string`
3237
33 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
38 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
3439
3540 - `"message-batches-2024-09-24"`
3641
from line 83
7883
7984 - `"user-profiles-2026-08-18"`
8085
86 - `"user-profiles-2026-09-04"`
87
8188 - `"advisor-tool-2026-03-01"`
8289
8390 - `"managed-agents-2026-04-01"`
from line 127
120127
121128 - `"mid-conversation-system-clear-at-2026-08-21"`
122129
130- `"anthropic-workspace-id": optional string`
131
123132## Returns
124133
125134- `data: array of BetaTunnel`
from line 135
126135
127136 List of tunnels, ordered by created_at descending.
128137
138 - `type: "tunnel"`
139
129140 - `id: string`
130141
131142 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 160
149160 - `domain: string`
150161
151162 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
152
153 - `type: "tunnel"`
154163
155164- `next_page: string or null`
156165
api/beta/tunnels/retrieve Changed · +12 / -3 lines
from line 1
1---
2title: Get Tunnel
3url: https://platform.claude.com/docs/en/api/beta/tunnels/retrieve
4---
5
16# Get Tunnel
27
38**GET** `/v1/tunnels/{tunnel_id}`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaTunnel object`
from line 123
114123
115124 An MCP tunnel.
116125
126 - `type: "tunnel"`
127
117128 - `id: string`
118129
119130 Unique identifier for the tunnel, prefixed with `tnl_`.
from line 148
137148 - `domain: string`
138149
139150 Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived.
140
141 - `type: "tunnel"`
142151
143152## Example
144153
api/beta/tunnels/reveal_token Changed · +12 / -3 lines
from line 1
1---
2title: Reveal Tunnel Token
3url: https://platform.claude.com/docs/en/api/beta/tunnels/reveal_token
4---
5
16# Reveal Tunnel Token
27
38**POST** `/v1/tunnels/{tunnel_id}/reveal_token`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Returns
112121
113122- `BetaTunnelToken object`
from line 123
114123
115124 A tunnel's connector token.
116125
126 - `type: "tunnel_token"`
127
117128 - `id: string`
118129
119130 Stable identifier for the current token value. Changes when the token is rotated.
from line 132
121132 - `tunnel_token: string`
122133
123134 The connector token used to run the tunnel. Treat as a credential.
124
125 - `type: "tunnel_token"`
126135
127136## Example
128137
api/beta/tunnels/rotate_token Changed · +12 / -3 lines
from line 1
1---
2title: Rotate Tunnel Token
3url: https://platform.claude.com/docs/en/api/beta/tunnels/rotate_token
4---
5
16# Rotate Tunnel Token
27
38**POST** `/v1/tunnels/{tunnel_id}/rotate_token`
from line 23
1823
1924 - `string`
2025
21 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
26 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2227
2328 - `"message-batches-2024-09-24"`
2429
from line 71
6671
6772 - `"user-profiles-2026-08-18"`
6873
74 - `"user-profiles-2026-09-04"`
75
6976 - `"advisor-tool-2026-03-01"`
7077
7178 - `"managed-agents-2026-04-01"`
from line 115
108115
109116 - `"mid-conversation-system-clear-at-2026-08-21"`
110117
118- `"anthropic-workspace-id": optional string`
119
111120## Body parameters
112121
113122- `reason: optional string or null`
from line 131
122131
123132 A tunnel's connector token.
124133
134 - `type: "tunnel_token"`
135
125136 - `id: string`
126137
127138 Stable identifier for the current token value. Changes when the token is rotated.
from line 140
129140 - `tunnel_token: string`
130141
131142 The connector token used to run the tunnel. Treat as a credential.
132
133 - `type: "tunnel_token"`
134143
135144## Example
136145
api/beta/user_profiles Changed · +543 / -40 lines
### Beta User Profile External User Details ### Beta User Profile External User Details Params
The two sides of this change are more than 400 edits apart, too far apart to line up, so this is the differ's own diff of it and the words inside a line are not marked.
from line 1
1---
2title: User Profiles
3url: https://platform.claude.com/docs/en/api/beta/user_profiles
4---
5
16# User Profiles
27
38## Create User Profile
from line 19
1419
1520 - `string`
1621
17 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
22 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1823
1924 - `"message-batches-2024-09-24"`
2025
from line 67
6267
6368 - `"user-profiles-2026-08-18"`
6469
70 - `"user-profiles-2026-09-04"`
71
6572 - `"advisor-tool-2026-03-01"`
6673
6774 - `"managed-agents-2026-04-01"`
from line 123
116123
117124- `external_id: optional string or null`
118125
119 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
126 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.
120127
121128 minLength: 1, maxLength: 255
122129
130- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
131
132 Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only.
133
134 - `account_status: optional "active" or "suspended" or "blocked" or null`
135
136 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
137
138 - `"active"`
139
140 - `"suspended"`
141
142 - `"blocked"`
143
144 - `country: optional string or null`
145
146 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.
147
148 - `email_hash: optional string or null`
149
150 A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
151
152 minLength: 1, maxLength: 255
153
154 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
155
156 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
157
158 - `"individual"`
159
160 - `"business"`
161
162 - `"non_profit"`
163
164 - `"government"`
165
166 - `name_hash: optional string or null`
167
168 A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
169
170 minLength: 1, maxLength: 255
171
172 - `onboarded_at: optional string`
173
174 A timestamp in RFC 3339 format
175
176 format: date-time
177
178 - `reference_id: optional string or null`
179
180 The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.
181
182 minLength: 1, maxLength: 255
183
123184- `external_user_onboarded_at: optional string`
124185
125186 A timestamp in RFC 3339 format
from line 201
140201
141202- `BetaUserProfile object`
142203
204 - `type: "user_profile"`
205
206 Object type. Always `user_profile`.
207
143208 - `id: string`
144209
145210 Unique identifier for this user profile, prefixed `uprof_`.
from line 233
168233
169234 - `"rejected"`
170235
171 - `type: "user_profile"`
172
173 Object type. Always `user_profile`.
174
175236 - `updated_at: string`
176237
177238 A timestamp in RFC 3339 format
from line 249
188249
189250 - `external_id: optional string or null`
190251
191 Platform's own identifier for this user. Not enforced unique.
252 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`.
253
254 - `external_user_details: optional BetaUserProfileExternalUserDetails`
255
256 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
257
258 - `account_status: "active" or "suspended" or "blocked" or null`
259
260 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
261
262 - `"active"`
263
264 - `"suspended"`
265
266 - `"blocked"`
267
268 - `country: string or null`
269
270 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
271
272 - `email_hash: string or null`
273
274 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
275
276 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
277
278 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
279
280 - `"individual"`
281
282 - `"business"`
283
284 - `"non_profit"`
285
286 - `"government"`
287
288 - `name_hash: string or null`
289
290 The platform-computed hash of the entity's name. `null` until the platform supplies one.
291
292 - `onboarded_at: string or null`
293
294 A timestamp in RFC 3339 format
295
296 format: date-time
297
298 - `reference_id: string or null`
299
300 The platform's own reference for the entity. `null` until the platform supplies one.
192301
193302 - `external_user_onboarded_at: optional string or null`
194303
from line 340
231340 "updated_at": "2026-03-15T10:00:00Z",
232341 "access_type": "application",
233342 "external_id": "user_12345",
343 "external_user_details": {
344 "account_status": "active",
345 "country": "country",
346 "email_hash": "email_hash",
347 "entity_type": "individual",
348 "name_hash": "name_hash",
349 "onboarded_at": "2019-12-27T18:11:19.117Z",
350 "reference_id": "reference_id"
351 },
234352 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
235353 "name": "Example User"
236354}
from line 396
278396
279397 - `string`
280398
281 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
399 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
282400
283401 - `"message-batches-2024-09-24"`
284402
from line 444
326444
327445 - `"user-profiles-2026-08-18"`
328446
447 - `"user-profiles-2026-09-04"`
448
329449 - `"advisor-tool-2026-03-01"`
330450
331451 - `"managed-agents-2026-04-01"`
from line 494
374494
375495 User profiles on this page.
376496
497 - `type: "user_profile"`
498
499 Object type. Always `user_profile`.
500
377501 - `id: string`
378502
379503 Unique identifier for this user profile, prefixed `uprof_`.
from line 526
402526
403527 - `"rejected"`
404528
405 - `type: "user_profile"`
406
407 Object type. Always `user_profile`.
408
409529 - `updated_at: string`
410530
411531 A timestamp in RFC 3339 format
from line 542
422542
423543 - `external_id: optional string or null`
424544
425 Platform's own identifier for this user. Not enforced unique.
545 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`.
546
547 - `external_user_details: optional BetaUserProfileExternalUserDetails`
548
549 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
550
551 - `account_status: "active" or "suspended" or "blocked" or null`
552
553 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
554
555 - `"active"`
556
557 - `"suspended"`
558
559 - `"blocked"`
560
561 - `country: string or null`
562
563 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
564
565 - `email_hash: string or null`
566
567 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
568
569 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
570
571 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
572
573 - `"individual"`
574
575 - `"business"`
576
577 - `"non_profit"`
578
579 - `"government"`
580
581 - `name_hash: string or null`
582
583 The platform-computed hash of the entity's name. `null` until the platform supplies one.
584
585 - `onboarded_at: string or null`
586
587 A timestamp in RFC 3339 format
588
589 format: date-time
590
591 - `reference_id: string or null`
592
593 The platform's own reference for the entity. `null` until the platform supplies one.
426594
427595 - `external_user_onboarded_at: optional string or null`
428596
from line 633
465633 "updated_at": "2026-03-15T10:00:00Z",
466634 "access_type": "application",
467635 "external_id": "user_12345",
636 "external_user_details": {
637 "account_status": "active",
638 "country": "country",
639 "email_hash": "email_hash",
640 "entity_type": "individual",
641 "name_hash": "name_hash",
642 "onboarded_at": "2019-12-27T18:11:19.117Z",
643 "reference_id": "reference_id"
644 },
468645 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
469646 "name": "Example User"
470647 }
from line 668
491668
492669 - `string`
493670
494 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
671 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
495672
496673 - `"message-batches-2024-09-24"`
497674
from line 716
539716
540717 - `"user-profiles-2026-08-18"`
541718
719 - `"user-profiles-2026-09-04"`
720
542721 - `"advisor-tool-2026-03-01"`
543722
544723 - `"managed-agents-2026-04-01"`
from line 764
585764
586765- `BetaUserProfile object`
587766
767 - `type: "user_profile"`
768
769 Object type. Always `user_profile`.
770
588771 - `id: string`
589772
590773 Unique identifier for this user profile, prefixed `uprof_`.
from line 796
613796
614797 - `"rejected"`
615798
616 - `type: "user_profile"`
617
618 Object type. Always `user_profile`.
619
620799 - `updated_at: string`
621800
622801 A timestamp in RFC 3339 format
from line 812
633812
634813 - `external_id: optional string or null`
635814
636 Platform's own identifier for this user. Not enforced unique.
815 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`.
816
817 - `external_user_details: optional BetaUserProfileExternalUserDetails`
818
819 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
820
821 - `account_status: "active" or "suspended" or "blocked" or null`
822
823 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
824
825 - `"active"`
826
827 - `"suspended"`
828
829 - `"blocked"`
830
831 - `country: string or null`
832
833 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
834
835 - `email_hash: string or null`
836
837 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
838
839 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
840
841 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
842
843 - `"individual"`
844
845 - `"business"`
846
847 - `"non_profit"`
848
849 - `"government"`
850
851 - `name_hash: string or null`
852
853 The platform-computed hash of the entity's name. `null` until the platform supplies one.
854
855 - `onboarded_at: string or null`
856
857 A timestamp in RFC 3339 format
858
859 format: date-time
860
861 - `reference_id: string or null`
862
863 The platform's own reference for the entity. `null` until the platform supplies one.
637864
638865 - `external_user_onboarded_at: optional string or null`
639866
from line 897
670897 "updated_at": "2026-03-15T10:00:00Z",
671898 "access_type": "application",
672899 "external_id": "user_12345",
900 "external_user_details": {
901 "account_status": "active",
902 "country": "country",
903 "email_hash": "email_hash",
904 "entity_type": "individual",
905 "name_hash": "name_hash",
906 "onboarded_at": "2019-12-27T18:11:19.117Z",
907 "reference_id": "reference_id"
908 },
673909 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
674910 "name": "Example User"
675911}
from line 929
693929
694930 - `string`
695931
696 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
932 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
697933
698934 - `"message-batches-2024-09-24"`
699935
from line 977
741977
742978 - `"user-profiles-2026-08-18"`
743979
980 - `"user-profiles-2026-09-04"`
981
744982 - `"advisor-tool-2026-03-01"`
745983
746984 - `"managed-agents-2026-04-01"`
from line 1033
7951033
7961034- `external_id: optional string or null`
7971035
798 If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters.
1036 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.
7991037
8001038 minLength: 1, maxLength: 255
8011039
1040- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
1041
1042 Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only.
1043
1044 - `account_status: optional "active" or "suspended" or "blocked" or null`
1045
1046 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
1047
1048 - `"active"`
1049
1050 - `"suspended"`
1051
1052 - `"blocked"`
1053
1054 - `country: optional string or null`
1055
1056 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.
1057
1058 - `email_hash: optional string or null`
1059
1060 A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
1061
1062 minLength: 1, maxLength: 255
1063
1064 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
1065
1066 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
1067
1068 - `"individual"`
1069
1070 - `"business"`
1071
1072 - `"non_profit"`
1073
1074 - `"government"`
1075
1076 - `name_hash: optional string or null`
1077
1078 A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
1079
1080 minLength: 1, maxLength: 255
1081
1082 - `onboarded_at: optional string`
1083
1084 A timestamp in RFC 3339 format
1085
1086 format: date-time
1087
1088 - `reference_id: optional string or null`
1089
1090 The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.
1091
1092 minLength: 1, maxLength: 255
1093
8021094- `external_user_onboarded_at: optional string`
8031095
8041096 A timestamp in RFC 3339 format
from line 1111
8191111
8201112- `BetaUserProfile object`
8211113
1114 - `type: "user_profile"`
1115
1116 Object type. Always `user_profile`.
1117
8221118 - `id: string`
8231119
8241120 Unique identifier for this user profile, prefixed `uprof_`.
from line 1143
8471143
8481144 - `"rejected"`
8491145
850 - `type: "user_profile"`
851
852 Object type. Always `user_profile`.
853
8541146 - `updated_at: string`
8551147
8561148 A timestamp in RFC 3339 format
from line 1159
8671159
8681160 - `external_id: optional string or null`
8691161
870 Platform's own identifier for this user. Not enforced unique.
1162 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`.
1163
1164 - `external_user_details: optional BetaUserProfileExternalUserDetails`
1165
1166 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
1167
1168 - `account_status: "active" or "suspended" or "blocked" or null`
1169
1170 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
1171
1172 - `"active"`
1173
1174 - `"suspended"`
1175
1176 - `"blocked"`
1177
1178 - `country: string or null`
1179
1180 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
1181
1182 - `email_hash: string or null`
1183
1184 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
1185
1186 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
1187
1188 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
1189
1190 - `"individual"`
1191
1192 - `"business"`
1193
1194 - `"non_profit"`
1195
1196 - `"government"`
1197
1198 - `name_hash: string or null`
1199
1200 The platform-computed hash of the entity's name. `null` until the platform supplies one.
1201
1202 - `onboarded_at: string or null`
1203
1204 A timestamp in RFC 3339 format
1205
1206 format: date-time
1207
1208 - `reference_id: string or null`
1209
1210 The platform's own reference for the entity. `null` until the platform supplies one.
8711211
8721212 - `external_user_onboarded_at: optional string or null`
8731213
from line 1248
9081248 "updated_at": "2026-03-15T10:00:00Z",
9091249 "access_type": "application",
9101250 "external_id": "user_12345",
1251 "external_user_details": {
1252 "account_status": "active",
1253 "country": "country",
1254 "email_hash": "email_hash",
1255 "entity_type": "individual",
1256 "name_hash": "name_hash",
1257 "onboarded_at": "2019-12-27T18:11:19.117Z",
1258 "reference_id": "reference_id"
1259 },
9111260 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
9121261 "name": "Example User"
9131262}
from line 1280
9311280
9321281 - `string`
9331282
934 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
1283 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
9351284
9361285 - `"message-batches-2024-09-24"`
9371286
from line 1328
9791328
9801329 - `"user-profiles-2026-08-18"`
9811330
1331 - `"user-profiles-2026-09-04"`
1332
9821333 - `"advisor-tool-2026-03-01"`
9831334
9841335 - `"managed-agents-2026-04-01"`
from line 1376
10251376
10261377- `BetaUserProfileEnrollmentURL object`
10271378
1379 - `type: "enrollment_url"`
1380
1381 Object type. Always `enrollment_url`.
1382
10281383 - `expires_at: string`
10291384
10301385 A timestamp in RFC 3339 format
10311386
10321387 format: date-time
1033
1034 - `type: "enrollment_url"`
1035
1036 Object type. Always `enrollment_url`.
10371388
10381389 - `url: string`
10391390
from line 1416
10651416
10661417- `BetaUserProfile object`
10671418
1419 - `type: "user_profile"`
1420
1421 Object type. Always `user_profile`.
1422
10681423 - `id: string`
10691424
10701425 Unique identifier for this user profile, prefixed `uprof_`.
from line 1448
10931448
10941449 - `"rejected"`
10951450
1096 - `type: "user_profile"`
1097
1098 Object type. Always `user_profile`.
1099
11001451 - `updated_at: string`
11011452
11021453 A timestamp in RFC 3339 format
from line 1464
11131464
11141465 - `external_id: optional string or null`
11151466
1116 Platform's own identifier for this user. Not enforced unique.
1467 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`.
1468
1469 - `external_user_details: optional BetaUserProfileExternalUserDetails`
1470
1471 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
1472
1473 - `account_status: "active" or "suspended" or "blocked" or null`
1474
1475 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
1476
1477 - `"active"`
1478
1479 - `"suspended"`
1480
1481 - `"blocked"`
1482
1483 - `country: string or null`
1484
1485 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
1486
1487 - `email_hash: string or null`
1488
1489 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
1490
1491 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
1492
1493 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
1494
1495 - `"individual"`
1496
1497 - `"business"`
1498
1499 - `"non_profit"`
1500
1501 - `"government"`
1502
1503 - `name_hash: string or null`
1504
1505 The platform-computed hash of the entity's name. `null` until the platform supplies one.
1506
1507 - `onboarded_at: string or null`
1508
1509 A timestamp in RFC 3339 format
1510
1511 format: date-time
1512
1513 - `reference_id: string or null`
1514
1515 The platform's own reference for the entity. `null` until the platform supplies one.
11171516
11181517 - `external_user_onboarded_at: optional string or null`
11191518
from line 1528
11291528
11301529- `BetaUserProfileEnrollmentURL object`
11311530
1531 - `type: "enrollment_url"`
1532
1533 Object type. Always `enrollment_url`.
1534
11321535 - `expires_at: string`
11331536
11341537 A timestamp in RFC 3339 format
11351538
11361539 format: date-time
11371540
1138 - `type: "enrollment_url"`
1139
1140 Object type. Always `enrollment_url`.
1141
11421541 - `url: string`
11431542
11441543 Enrollment URL to send to the end user. Valid until `expires_at`.
11451544
1545### Beta User Profile External User Details
1546
1547- `BetaUserProfileExternalUserDetails object`
1548
1549 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
1550
1551 - `account_status: "active" or "suspended" or "blocked" or null`
1552
1553 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
1554
1555 - `"active"`
1556
1557 - `"suspended"`
1558
1559 - `"blocked"`
1560
1561 - `country: string or null`
1562
1563 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
1564
1565 - `email_hash: string or null`
1566
1567 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
1568
1569 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
1570
1571 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
1572
1573 - `"individual"`
1574
1575 - `"business"`
1576
1577 - `"non_profit"`
1578
1579 - `"government"`
1580
1581 - `name_hash: string or null`
1582
1583 The platform-computed hash of the entity's name. `null` until the platform supplies one.
1584
1585 - `onboarded_at: string or null`
1586
1587 A timestamp in RFC 3339 format
1588
1589 format: date-time
1590
1591 - `reference_id: string or null`
1592
1593 The platform's own reference for the entity. `null` until the platform supplies one.
1594
1595### Beta User Profile External User Details Params
1596
1597- `BetaUserProfileExternalUserDetailsParams object`
1598
1599 - `account_status: optional "active" or "suspended" or "blocked" or null`
1600
1601 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
1602
1603 - `"active"`
1604
1605 - `"suspended"`
1606
1607 - `"blocked"`
1608
1609 - `country: optional string or null`
1610
1611 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.
1612
1613 - `email_hash: optional string or null`
1614
1615 A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
1616
1617 minLength: 1, maxLength: 255
1618
1619 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
1620
1621 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
1622
1623 - `"individual"`
1624
1625 - `"business"`
1626
1627 - `"non_profit"`
1628
1629 - `"government"`
1630
1631 - `name_hash: optional string or null`
1632
1633 A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
1634
1635 minLength: 1, maxLength: 255
1636
1637 - `onboarded_at: optional string`
1638
1639 A timestamp in RFC 3339 format
1640
1641 format: date-time
1642
1643 - `reference_id: optional string or null`
1644
1645 The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.
1646
1647 minLength: 1, maxLength: 255
1648
11461649### Beta User Profile Trust Grant
11471650
11481651- `BetaUserProfileTrustGrant object`
11491652
api/beta/user_profiles/create Changed · +125 / -7 lines
from line 1
1---
2title: Create User Profile
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/create
4---
5
16# Create User Profile
27
38**POST** `/v1/user_profiles`
from line 17
1217
1318 - `string`
1419
15 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
20 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
1621
1722 - `"message-batches-2024-09-24"`
1823
from line 65
6065
6166 - `"user-profiles-2026-08-18"`
6267
68 - `"user-profiles-2026-09-04"`
69
6370 - `"advisor-tool-2026-03-01"`
6471
6572 - `"managed-agents-2026-04-01"`
from line 121
114121
115122- `external_id: optional string or null`
116123
117 Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
124 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.
118125
119126 minLength: 1, maxLength: 255
120127
128- `external_user_details: optional BetaUserProfileExternalUserDetailsParams`
129
130 Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only.
131
132 - `account_status: optional "active" or "suspended" or "blocked" or null`
133
134 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
135
136 - `"active"`
137
138 - `"suspended"`
139
140 - `"blocked"`
141
142 - `country: optional string or null`
143
144 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.
145
146 - `email_hash: optional string or null`
147
148 A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
149
150 minLength: 1, maxLength: 255
151
152 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null`
153
154 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
155
156 - `"individual"`
157
158 - `"business"`
159
160 - `"non_profit"`
161
162 - `"government"`
163
164 - `name_hash: optional string or null`
165
166 A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.
167
168 minLength: 1, maxLength: 255
169
170 - `onboarded_at: optional string`
171
172 A timestamp in RFC 3339 format
173
174 format: date-time
175
176 - `reference_id: optional string or null`
177
178 The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.
179
180 minLength: 1, maxLength: 255
181
121182- `external_user_onboarded_at: optional string`
122183
123184 A timestamp in RFC 3339 format
from line 199
138199
139200- `BetaUserProfile object`
140201
202 - `type: "user_profile"`
203
204 Object type. Always `user_profile`.
205
141206 - `id: string`
142207
143208 Unique identifier for this user profile, prefixed `uprof_`.
from line 231
166231
167232 - `"rejected"`
168233
169 - `type: "user_profile"`
170
171 Object type. Always `user_profile`.
172
173234 - `updated_at: string`
174235
175236 A timestamp in RFC 3339 format
from line 247
186247
187248 - `external_id: optional string or null`
188249
189 Platform's own identifier for this user. Not enforced unique.
250 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`.
190251
252 - `external_user_details: optional BetaUserProfileExternalUserDetails`
253
254 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
255
256 - `account_status: "active" or "suspended" or "blocked" or null`
257
258 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
259
260 - `"active"`
261
262 - `"suspended"`
263
264 - `"blocked"`
265
266 - `country: string or null`
267
268 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
269
270 - `email_hash: string or null`
271
272 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
273
274 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
275
276 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
277
278 - `"individual"`
279
280 - `"business"`
281
282 - `"non_profit"`
283
284 - `"government"`
285
286 - `name_hash: string or null`
287
288 The platform-computed hash of the entity's name. `null` until the platform supplies one.
289
290 - `onboarded_at: string or null`
291
292 A timestamp in RFC 3339 format
293
294 format: date-time
295
296 - `reference_id: string or null`
297
298 The platform's own reference for the entity. `null` until the platform supplies one.
299
191300 - `external_user_onboarded_at: optional string or null`
192301
193302 A timestamp in RFC 3339 format
from line 338
229338 "updated_at": "2026-03-15T10:00:00Z",
230339 "access_type": "application",
231340 "external_id": "user_12345",
341 "external_user_details": {
342 "account_status": "active",
343 "country": "country",
344 "email_hash": "email_hash",
345 "entity_type": "individual",
346 "name_hash": "name_hash",
347 "onboarded_at": "2019-12-27T18:11:19.117Z",
348 "reference_id": "reference_id"
349 },
232350 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
233351 "name": "Example User"
234352}
api/beta/user_profiles/create_enrollment_url Changed · +12 / -5 lines
from line 1
1---
2title: Create Enrollment URL
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/create_enrollment_url
4---
5
16# Create Enrollment URL
27
38**POST** `/v1/user_profiles/{user_profile_id}/enrollment_url`
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 117
110117
111118- `BetaUserProfileEnrollmentURL object`
112119
120 - `type: "enrollment_url"`
121
122 Object type. Always `enrollment_url`.
123
113124 - `expires_at: string`
114125
115126 A timestamp in RFC 3339 format
116127
117128 format: date-time
118
119 - `type: "enrollment_url"`
120
121 Object type. Always `enrollment_url`.
122129
123130 - `url: string`
124131
api/beta/user_profiles/list Changed · +70 / -6 lines
from line 1
1---
2title: List User Profiles
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/list
4---
5
16# List User Profiles
27
38**GET** `/v1/user_profiles`
from line 45
4045
4146 - `string`
4247
43 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
48 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
4449
4550 - `"message-batches-2024-09-24"`
4651
from line 93
8893
8994 - `"user-profiles-2026-08-18"`
9095
96 - `"user-profiles-2026-09-04"`
97
9198 - `"advisor-tool-2026-03-01"`
9299
93100 - `"managed-agents-2026-04-01"`
from line 143
136143
137144 User profiles on this page.
138145
146 - `type: "user_profile"`
147
148 Object type. Always `user_profile`.
149
139150 - `id: string`
140151
141152 Unique identifier for this user profile, prefixed `uprof_`.
from line 175
164175
165176 - `"rejected"`
166177
167 - `type: "user_profile"`
168
169 Object type. Always `user_profile`.
170
171178 - `updated_at: string`
172179
173180 A timestamp in RFC 3339 format
from line 191
184191
185192 - `external_id: optional string or null`
186193
187 Platform's own identifier for this user. Not enforced unique.
194 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`.
188195
196 - `external_user_details: optional BetaUserProfileExternalUserDetails`
197
198 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
199
200 - `account_status: "active" or "suspended" or "blocked" or null`
201
202 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
203
204 - `"active"`
205
206 - `"suspended"`
207
208 - `"blocked"`
209
210 - `country: string or null`
211
212 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
213
214 - `email_hash: string or null`
215
216 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
217
218 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
219
220 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
221
222 - `"individual"`
223
224 - `"business"`
225
226 - `"non_profit"`
227
228 - `"government"`
229
230 - `name_hash: string or null`
231
232 The platform-computed hash of the entity's name. `null` until the platform supplies one.
233
234 - `onboarded_at: string or null`
235
236 A timestamp in RFC 3339 format
237
238 format: date-time
239
240 - `reference_id: string or null`
241
242 The platform's own reference for the entity. `null` until the platform supplies one.
243
189244 - `external_user_onboarded_at: optional string or null`
190245
191246 A timestamp in RFC 3339 format
from line 282
227282 "updated_at": "2026-03-15T10:00:00Z",
228283 "access_type": "application",
229284 "external_id": "user_12345",
285 "external_user_details": {
286 "account_status": "active",
287 "country": "country",
288 "email_hash": "email_hash",
289 "entity_type": "individual",
290 "name_hash": "name_hash",
291 "onboarded_at": "2019-12-27T18:11:19.117Z",
292 "reference_id": "reference_id"
293 },
230294 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
231295 "name": "Example User"
232296 }
api/beta/user_profiles/retrieve Changed · +70 / -6 lines
from line 1
1---
2title: Get User Profile
3url: https://platform.claude.com/docs/en/api/beta/user_profiles/retrieve
4---
5
16# Get User Profile
27
38**GET** `/v1/user_profiles/{user_profile_id}`
from line 21
1621
1722 - `string`
1823
19 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 41 more`
24 - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 42 more`
2025
2126 - `"message-batches-2024-09-24"`
2227
from line 69
6469
6570 - `"user-profiles-2026-08-18"`
6671
72 - `"user-profiles-2026-09-04"`
73
6774 - `"advisor-tool-2026-03-01"`
6875
6976 - `"managed-agents-2026-04-01"`
from line 117
110117
111118- `BetaUserProfile object`
112119
120 - `type: "user_profile"`
121
122 Object type. Always `user_profile`.
123
113124 - `id: string`
114125
115126 Unique identifier for this user profile, prefixed `uprof_`.
from line 149
138149
139150 - `"rejected"`
140151
141 - `type: "user_profile"`
142
143 Object type. Always `user_profile`.
144
145152 - `updated_at: string`
146153
147154 A timestamp in RFC 3339 format
from line 165
158165
159166 - `external_id: optional string or null`
160167
161 Platform's own identifier for this user. Not enforced unique.
168 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`.
162169
170 - `external_user_details: optional BetaUserProfileExternalUserDetails`
171
172 Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value.
173
174 - `account_status: "active" or "suspended" or "blocked" or null`
175
176 The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it.
177
178 - `"active"`
179
180 - `"suspended"`
181
182 - `"blocked"`
183
184 - `country: string or null`
185
186 The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one.
187
188 - `email_hash: string or null`
189
190 The platform-computed hash of the entity's email address. `null` until the platform supplies one.
191
192 - `entity_type: "individual" or "business" or "non_profit" or "government" or null`
193
194 What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`.
195
196 - `"individual"`
197
198 - `"business"`
199
200 - `"non_profit"`
201
202 - `"government"`
203
204 - `name_hash: string or null`
205
206 The platform-computed hash of the entity's name. `null` until the platform supplies one.
207
208 - `onboarded_at: string or null`
209
210 A timestamp in RFC 3339 format
211
212 format: date-time
213
214 - `reference_id: string or null`
215
216 The platform's own reference for the entity. `null` until the platform supplies one.
217
163218 - `external_user_onboarded_at: optional string or null`
164219
165220 A timestamp in RFC 3339 format
from line 250
195250 "updated_at": "2026-03-15T10:00:00Z",
196251 "access_type": "application",
197252 "external_id": "user_12345",
253 "external_user_details": {
254 "account_status": "active",
255 "country": "country",
256 "email_hash": "email_hash",
257 "entity_type": "individual",
258 "name_hash": "name_hash",
259 "onboarded_at": "2019-12-27T18:11:19.117Z",
260 "reference_id": "reference_id"
261 },
198262 "external_user_onboarded_at": "2024-11-02T08:15:00Z",
199263 "name": "Example User"
200264}