One read of Claude Developer Platformapi-20261012T063709Z
394 pages moved out of 760 read.
Pages moved
394
significant first
Pages read
760
in this capture
Captured
06:37 UTC
Corpus hash
a680f764ff92
corpus-hash
What this read moved
76-100 of 394, page 4 of 16This capture is too large to show at once. Changes 76-100 of 394 are below, significant first; the rest are on the following screens.
api/messages/batches/create Changed · +21 / -21 lines
from line 11
1111
1212The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete.
1313
14Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
14Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
1515
1616## Headers
1717
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424- `"anthropic-user-profile-id": optional string`
2525
from line 51
5151
5252 Messages API creation parameters for the individual request.
5353
54 See the [Messages API reference](https://platform.claude.com/docs/en/api/messages) for full documentation on available parameters.
54 See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=http) for full documentation on available parameters.
5555
5656 - `max_tokens: number`
5757
from line 59
5959
6060 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
6161
62 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.
62 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response.
6363
64 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.
64 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details.
6565
6666 minimum: 0
6767
from line 73
7373
7474 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
7575
76 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
76 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
7777
7878 Example with a single `user` message:
7979
from line 110
110110 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
111111 ```
112112
113 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
113 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
114114
115 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
115 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
116116
117117 There is a limit of 100,000 messages in a single request.
118118
from line 145
145145 - `5m`: 5 minutes
146146 - `1h`: 1 hour
147147
148 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
148 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
149149
150150 - `"5m"`
151151
from line 1275
12751275
12761276 - `format: optional JSONOutputFormat or null`
12771277
1278 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
1278 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
12791279
12801280 - `type: "json_schema"`
12811281
from line 1287
12871287
12881288 Determines whether to use priority capacity (if available) or standard capacity for this request.
12891289
1290 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.
1290 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details.
12911291
12921292 - `"auto"`
12931293
from line 1305
13051305
13061306 Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream.
13071307
1308 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming#streaming-with-sdks) for an example in each language.
1308 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language.
13091309
13101310 - `system: optional string or array of TextBlockParam`
13111311
13121312 System prompt.
13131313
1314 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
1314 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
13151315
13161316 - `string`
13171317
from line 1335
13351335
13361336 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
13371337
1338 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
1338 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
13391339
13401340 - `ThinkingConfigEnabled object`
13411341
from line 1347
13471347
13481348 Must be ≥1024 and less than `max_tokens`.
13491349
1350 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
1350 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
13511351
13521352 minimum: 1024
13531353
13541354 - `display: optional "summarized" or "omitted" or null`
13551355
1356 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1356 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13571357
13581358 - `"summarized"`
13591359
from line 1373
13731373
13741374 - `display: optional "summarized" or "omitted" or null`
13751375
1376 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1376 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13771377
13781378 - `"summarized"`
13791379
from line 1435
14351435
14361436 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
14371437
1438 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
1438 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
14391439
14401440 Each tool definition includes:
14411441
from line 1491
14911491
14921492 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
14931493
1494 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
1494 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
14951495
14961496 - `Tool object`
14971497
api/messages/batches/results Changed · +5 / -5 lines
from line 11
1111
1212Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests.
1313
14Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing)
14Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http)
1515
1616## Path parameters
1717
from line 25
2525
2626 The version of the Claude API you want to use.
2727
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2929
3030- `"anthropic-workspace-id": optional string`
3131
from line 296
296296
297297 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
298298
299 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
299 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
300300
301301 - `thinking: string`
302302
from line 314
314314
315315 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
316316
317 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
317 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
318318
319319 - `ToolUseBlock object`
320320
from line 1016
10161016
10171017 - `"reasoning_extraction"`
10181018
1019 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
1019 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
10201020
10211021 - `"general_harms"`
10221022
api/messages/count_tokens Changed · +15 / -15 lines
from line 11
1111
1212The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it.
1313
14Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting)
14Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=http)
1515
1616## Headers
1717
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424- `"anthropic-user-profile-id": optional string`
2525
from line 41
4141
4242 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
4343
44 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
44 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
4545
4646 Example with a single `user` message:
4747
from line 78
7878 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
7979 ```
8080
81 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
81 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
8282
83 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
83 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
8484
8585 There is a limit of 100,000 messages in a single request.
8686
from line 113
113113 - `5m`: 5 minutes
114114 - `1h`: 1 hour
115115
116 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
116 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
117117
118118 - `"5m"`
119119
from line 1177
11771177
11781178 - `format: optional JSONOutputFormat or null`
11791179
1180 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
1180 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
11811181
11821182 - `type: "json_schema"`
11831183
from line 1189
11891189
11901190 System prompt.
11911191
1192 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
1192 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
11931193
11941194 - `string`
11951195
from line 1213
12131213
12141214 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
12151215
1216 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
1216 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
12171217
12181218 - `ThinkingConfigEnabled object`
12191219
from line 1225
12251225
12261226 Must be ≥1024 and less than `max_tokens`.
12271227
1228 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
1228 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
12291229
12301230 minimum: 1024
12311231
12321232 - `display: optional "summarized" or "omitted" or null`
12331233
1234 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1234 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
12351235
12361236 - `"summarized"`
12371237
from line 1251
12511251
12521252 - `display: optional "summarized" or "omitted" or null`
12531253
1254 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1254 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
12551255
12561256 - `"summarized"`
12571257
from line 1313
13131313
13141314 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
13151315
1316 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
1316 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
13171317
13181318 Each tool definition includes:
13191319
from line 1369
13691369
13701370 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
13711371
1372 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
1372 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
13731373
13741374 - `Tool object`
13751375
api/messages/create Changed · +23 / -23 lines
from line 11
1111
1212The Messages API can be used for either single queries or stateless multi-turn conversations.
1313
14Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started)
14Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started?sdk_languages=http)
1515
1616## Headers
1717
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424- `"anthropic-user-profile-id": optional string`
2525
from line 39
3939
4040 Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.
4141
42 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response.
42 Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response.
4343
44 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details.
44 Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details.
4545
4646 minimum: 0
4747
from line 53
5353
5454 Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages.
5555
56 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors#prefill-not-supported).
56 If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported).
5757
5858 Example with a single `user` message:
5959
from line 90
9090 {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}
9191 ```
9292
93 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages).
93 See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http).
9494
95 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
95 Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API.
9696
9797 There is a limit of 100,000 messages in a single request.
9898
from line 125
125125 - `5m`: 5 minutes
126126 - `1h`: 1 hour
127127
128 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details.
128 Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details.
129129
130130 - `"5m"`
131131
from line 1255
12551255
12561256 - `format: optional JSONOutputFormat or null`
12571257
1258 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs)
1258 A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http)
12591259
12601260 - `type: "json_schema"`
12611261
from line 1267
12671267
12681268 Determines whether to use priority capacity (if available) or standard capacity for this request.
12691269
1270 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details.
1270 Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details.
12711271
12721272 - `"auto"`
12731273
from line 1285
12851285
12861286 Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream.
12871287
1288 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming#streaming-with-sdks) for an example in each language.
1288 In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language.
12891289
12901290- `system: optional string or array of TextBlockParam`
12911291
12921292 System prompt.
12931293
1294 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role).
1294 A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role).
12951295
12961296 - `string`
12971297
from line 1315
13151315
13161316 With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit.
13171317
1318 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking#configuring-thinking) for each model's behavior.
1318 Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior.
13191319
13201320 - `ThinkingConfigEnabled object`
13211321
from line 1327
13271327
13281328 Must be ≥1024 and less than `max_tokens`.
13291329
1330 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
1330 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
13311331
13321332 minimum: 1024
13331333
13341334 - `display: optional "summarized" or "omitted" or null`
13351335
1336 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1336 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13371337
13381338 - `"summarized"`
13391339
from line 1353
13531353
13541354 - `display: optional "summarized" or "omitted" or null`
13551355
1356 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking#controlling-thinking-display).
1356 Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display).
13571357
13581358 - `"summarized"`
13591359
from line 1415
14151415
14161416 If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks.
14171417
1418 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)).
1418 There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)).
14191419
14201420 Each tool definition includes:
14211421
from line 1471
14711471
14721472 Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
14731473
1474 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details.
1474 See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details.
14751475
14761476 - `Tool object`
14771477
from line 3326
33263326
33273327 This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.
33283328
3329 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details.
3329 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details.
33303330
33313331 - `thinking: string`
33323332
from line 3344
33443344
33453345 Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation.
33463346
3347 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details.
3347 See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details.
33483348
33493349 - `ToolUseBlock object`
33503350
from line 4046
40464046
40474047 - `"reasoning_extraction"`
40484048
4049 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking).
4049 The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http).
40504050
40514051 - `"general_harms"`
40524052
api/organization Changed · +84 / -84 lines
from line 17
1717
1818 The version of the Claude API you want to use.
1919
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2121
2222### Returns
2323
from line 157
157157
158158 The version of the Claude API you want to use.
159159
160 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
160 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
161161
162162#### Returns
163163
from line 355
355355
356356 The version of the Claude API you want to use.
357357
358 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
358 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
359359
360360#### Returns
361361
from line 534
534534
535535 The version of the Claude API you want to use.
536536
537 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
537 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
538538
539539#### Body parameters
540540
from line 729
729729
730730 The version of the Claude API you want to use.
731731
732 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
732 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
733733
734734#### Body parameters
735735
from line 963
963963
964964 The version of the Claude API you want to use.
965965
966 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
966 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
967967
968968#### Returns
969969
from line 1120
11201120
11211121 The version of the Claude API you want to use.
11221122
1123 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1123 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
11241124
11251125#### Returns
11261126
from line 1278
12781278
12791279 The version of the Claude API you want to use.
12801280
1281 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1281 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
12821282
12831283#### Body parameters
12841284
from line 1502
15021502
15031503 The version of the Claude API you want to use.
15041504
1505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15061506
15071507#### Returns
15081508
from line 1557
15571557
15581558 The version of the Claude API you want to use.
15591559
1560 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1560 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15611561
15621562#### Returns
15631563
from line 1602
16021602
16031603**POST** `/v1/organizations/federation_issuers`
16041604
1605**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1605**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
16061606
16071607Register an OIDC issuer that Anthropic will trust for workload identity
16081608federation in your organization.
from line 1622
16221622
16231623 The version of the Claude API you want to use.
16241624
1625 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1625 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16261626
16271627#### Body parameters
16281628
from line 1884
18841884
18851885**GET** `/v1/organizations/federation_issuers`
18861886
1887**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1887**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
18881888
18891889List federation issuers in your organization.
18901890
from line 1914
19141914
19151915 The version of the Claude API you want to use.
19161916
1917 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1917 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
19181918
19191919#### Returns
19201920
from line 2101
21012101
21022102**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}`
21032103
2104**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2104**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
21052105
21062106Retrieve a federation issuer by its ID (`fdis_...`).
21072107
from line 2117
21172117
21182118 The version of the Claude API you want to use.
21192119
2120 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2120 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
21212121
21222122#### Returns
21232123
from line 2300
23002300
23012301**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}`
23022302
2303**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2303**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
23042304
23052305Partially update a federation issuer.
23062306
from line 2323
23232323
23242324 The version of the Claude API you want to use.
23252325
2326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
23272327
23282328#### Body parameters
23292329
from line 2586
25862586
25872587**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive`
25882588
2589**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2589**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
25902590
25912591Archive a federation issuer.
25922592
from line 2607
26072607
26082608 The version of the Claude API you want to use.
26092609
2610 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2610 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
26112611
26122612#### Returns
26132613
from line 2793
27932793
27942794**POST** `/v1/organizations/federation_rules`
27952795
2796**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2796**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
27972797
27982798Create a federation rule owned by your organization.
27992799
from line 2817
28172817
28182818 The version of the Claude API you want to use.
28192819
2820 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2820 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
28212821
28222822#### Body parameters
28232823
from line 3099
30993099
31003100**GET** `/v1/organizations/federation_rules`
31013101
3102**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
3102**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
31033103
31043104List federation rules in your organization.
31053105
from line 3134
31343134
31353135 The version of the Claude API you want to use.
31363136
3137 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3137 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
31383138
31393139#### Returns
31403140
from line 3321
33213321
33223322**GET** `/v1/organizations/federation_rules/{federation_rule_id}`
33233323
3324**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
3324**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
33253325
33263326Retrieve a federation rule by its ID (`fdrl_...`).
33273327
from line 3337
33373337
33383338 The version of the Claude API you want to use.
33393339
3340 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3340 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
33413341
33423342#### Returns
33433343
from line 3526
35263526
35273527**POST** `/v1/organizations/federation_rules/{federation_rule_id}`
35283528
3529**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
3529**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
35303530
35313531Partially update a federation rule.
35323532
from line 3558
35583558
35593559 The version of the Claude API you want to use.
35603560
3561 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3561 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
35623562
35633563#### Body parameters
35643564
from line 3827
38273827
38283828**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive`
38293829
3830**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
3830**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
38313831
38323832Archive a federation rule.
38333833
from line 3851
38513851
38523852 The version of the Claude API you want to use.
38533853
3854 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
3854 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
38553855
38563856#### Returns
38573857
from line 4043
40434043
40444044**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
40454045
4046**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
4046**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
40474047
40484048Enable a federation rule for a workspace.
40494049
from line 4068
40684068
40694069 The version of the Claude API you want to use.
40704070
4071 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4071 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
40724072
40734073#### Body parameters
40744074
from line 4135
41354135
41364136**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
41374137
4138**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
4138**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
41394139
41404140List workspaces where this federation rule is enabled.
41414141
from line 4169
41694169
41704170 The version of the Claude API you want to use.
41714171
4172 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4172 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
41734173
41744174#### Returns
41754175
from line 4235
42354235
42364236**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}`
42374237
4238**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
4238**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
42394239
42404240Disable a federation rule for a workspace.
42414241
from line 4260
42604260
42614261 The version of the Claude API you want to use.
42624262
4263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
42644264
42654265#### Returns
42664266
from line 4311
43114311
43124312 The version of the Claude API you want to use.
43134313
4314 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4314 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
43154315
43164316#### Body parameters
43174317
from line 4502
45024502
45034503 The version of the Claude API you want to use.
45044504
4505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4505 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
45064506
45074507#### Returns
45084508
from line 4643
46434643
46444644 The version of the Claude API you want to use.
46454645
4646 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4646 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
46474647
46484648#### Returns
46494649
from line 4765
47654765
47664766 The version of the Claude API you want to use.
47674767
4768 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4768 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
47694769
47704770#### Returns
47714771
from line 4805
48054805
48064806**POST** `/v1/organizations/service_accounts`
48074807
4808**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
4808**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
48094809
48104810Create a service account.
48114811
from line 4823
48234823
48244824 The version of the Claude API you want to use.
48254825
4826 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4826 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
48274827
48284828#### Body parameters
48294829
from line 4944
49444944
49454945**GET** `/v1/organizations/service_accounts`
49464946
4947**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
4947**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
49484948
49494949List service accounts in the caller's organization.
49504950
from line 4976
49764976
49774977 The version of the Claude API you want to use.
49784978
4979 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
4979 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
49804980
49814981#### Returns
49824982
from line 5075
50755075
50765076**GET** `/v1/organizations/service_accounts/{service_account_id}`
50775077
5078**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5078**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
50795079
50805080Retrieve a service account by its ID (`svac_...`).
50815081
from line 5091
50915091
50925092 The version of the Claude API you want to use.
50935093
5094 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5094 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
50955095
50965096#### Returns
50975097
from line 5186
51865186
51875187**POST** `/v1/organizations/service_accounts/{service_account_id}`
51885188
5189**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5189**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
51905190
51915191Update a service account.
51925192
from line 5207
52075207
52085208 The version of the Claude API you want to use.
52095209
5210 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5210 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
52115211
52125212#### Body parameters
52135213
from line 5320
53205320
53215321**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
53225322
5323**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5323**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
53245324
53255325Archive a service account.
53265326
from line 5341
53415341
53425342 The version of the Claude API you want to use.
53435343
5344 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5344 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
53455345
53465346#### Returns
53475347
from line 5439
54395439
54405440**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
54415441
5442**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5442**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
54435443
54445444Add a service account to a workspace with the given `workspace_role`.
54455445
from line 5462
54625462
54635463 The version of the Claude API you want to use.
54645464
5465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5465 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
54665466
54675467#### Body parameters
54685468
from line 5550
55505550
55515551**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
55525552
5553**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5553**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
55545554
55555555List the workspaces a service account is a member of.
55565556
from line 5592
55925592
55935593 The version of the Claude API you want to use.
55945594
5595 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5595 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
55965596
55975597#### Returns
55985598
from line 5666
56665666
56675667**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
56685668
5669**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
5669**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
56705670
56715671Remove a service account from a workspace.
56725672
from line 5694
56945694
56955695 The version of the Claude API you want to use.
56965696
5697 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5697 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
56985698
56995699#### Returns
57005700
from line 5773
57735773
57745774 The version of the Claude API you want to use.
57755775
5776 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5776 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
57775777
57785778#### Returns
57795779
from line 5885
58855885
58865886 The version of the Claude API you want to use.
58875887
5888 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5888 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
58895889
58905890#### Returns
58915891
from line 5978
59785978
59795979 The version of the Claude API you want to use.
59805980
5981 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
5981 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
59825982
59835983#### Body parameters
59845984
from line 6093
60936093
60946094 The version of the Claude API you want to use.
60956095
6096 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6096 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
60976097
60986098#### Returns
60996099
from line 6171
61716171
61726172 The version of the Claude API you want to use.
61736173
6174 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6174 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
61756175
61766176#### Returns
61776177
from line 6332
63326332
63336333 The version of the Claude API you want to use.
63346334
6335 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6335 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
63366336
63376337#### Body parameters
63386338
from line 6550
65506550
65516551 The version of the Claude API you want to use.
65526552
6553 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6553 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
65546554
65556555#### Returns
65566556
from line 6696
66966696
66976697 The version of the Claude API you want to use.
66986698
6699 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6699 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
67006700
67016701#### Body parameters
67026702
from line 6907
69076907
69086908 The version of the Claude API you want to use.
69096909
6910 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
6910 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
69116911
69126912#### Returns
69136913
from line 7104
71047104
71057105 The version of the Claude API you want to use.
71067106
7107 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7107 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
71087108
71097109#### Returns
71107110
from line 7348
73487348
73497349 The version of the Claude API you want to use.
73507350
7351 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7351 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
73527352
73537353#### Returns
73547354
from line 7440
74407440
74417441 The version of the Claude API you want to use.
74427442
7443 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7443 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
74447444
74457445#### Body parameters
74467446
from line 7540
75407540
75417541 The version of the Claude API you want to use.
75427542
7543 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7543 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
75447544
75457545#### Returns
75467546
from line 7617
76177617
76187618 The version of the Claude API you want to use.
76197619
7620 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7620 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
76217621
76227622#### Body parameters
76237623
from line 7714
77147714
77157715 The version of the Claude API you want to use.
77167716
7717 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7717 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
77187718
77197719#### Returns
77207720
from line 7759
77597759
77607760**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
77617761
7762**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
7762**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
77637763
77647764List the service accounts that are members of a workspace.
77657765
from line 7794
77947794
77957795 The version of the Claude API you want to use.
77967796
7797 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7797 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
77987798
77997799#### Returns
78007800
from line 7868
78687868
78697869**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
78707870
7871**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
7871**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
78727872
78737873Add a service account to a workspace with the given `workspace_role`.
78747874
from line 7893
78937893
78947894 The version of the Claude API you want to use.
78957895
7896 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
7896 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
78977897
78987898#### Body parameters
78997899
from line 7981
79817981
79827982**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
79837983
7984**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
7984**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
79857985
79867986Retrieve a service account's membership in a workspace.
79877987
from line 8008
80088008
80098009 The version of the Claude API you want to use.
80108010
8011 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8011 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
80128012
80138013#### Returns
80148014
from line 8073
80738073
80748074**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
80758075
8076**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
8076**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
80778077
80788078Change a service account's role in a workspace.
80798079
from line 8100
81008100
81018101 The version of the Claude API you want to use.
81028102
8103 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8103 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
81048104
81058105#### Body parameters
81068106
from line 8183
81838183
81848184**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
81858185
8186**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
8186**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
81878187
81888188Remove a service account from a workspace.
81898189
from line 8209
82098209
82108210 The version of the Claude API you want to use.
82118211
8212 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8212 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
82138213
82148214#### Returns
82158215
from line 8300
83008300
83018301 The version of the Claude API you want to use.
83028302
8303 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8303 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
83048304
83058305#### Returns
83068306
from line 8492
84928492
84938493 The version of the Claude API you want to use.
84948494
8495 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8495 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
84968496
84978497#### Returns
84988498
from line 8562
85628562
85638563 The version of the Claude API you want to use.
85648564
8565 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
8565 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
85668566
85678567#### Body parameters
85688568
api/organization/api_keys Changed · +3 / -3 lines
from line 55
5555
5656 The version of the Claude API you want to use.
5757
58 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
58 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
5959
6060### Returns
6161
from line 253
253253
254254 The version of the Claude API you want to use.
255255
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
256 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
257257
258258### Returns
259259
from line 432
432432
433433 The version of the Claude API you want to use.
434434
435 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
435 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
436436
437437### Body parameters
438438
api/organization/external_keys Changed · +6 / -6 lines
from line 17
1717
1818 The version of the Claude API you want to use.
1919
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2121
2222### Body parameters
2323
from line 251
251251
252252 The version of the Claude API you want to use.
253253
254 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
254 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
255255
256256### Returns
257257
from line 408
408408
409409 The version of the Claude API you want to use.
410410
411 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
411 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
412412
413413### Returns
414414
from line 566
566566
567567 The version of the Claude API you want to use.
568568
569 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
569 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
570570
571571### Body parameters
572572
from line 790
790790
791791 The version of the Claude API you want to use.
792792
793 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
793 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
794794
795795### Returns
796796
from line 845
845845
846846 The version of the Claude API you want to use.
847847
848 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
848 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
849849
850850### Returns
851851
api/organization/federation Changed · +26 / -26 lines
from line 11
1111
1212**POST** `/v1/organizations/federation_issuers`
1313
14**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
14**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1515
1616Register an OIDC issuer that Anthropic will trust for workload identity
1717federation in your organization.
from line 31
3131
3232 The version of the Claude API you want to use.
3333
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
34 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3535
3636#### Body parameters
3737
from line 293
293293
294294**GET** `/v1/organizations/federation_issuers`
295295
296**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
296**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
297297
298298List federation issuers in your organization.
299299
from line 323
323323
324324 The version of the Claude API you want to use.
325325
326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
326 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
327327
328328#### Returns
329329
from line 510
510510
511511**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}`
512512
513**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
513**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
514514
515515Retrieve a federation issuer by its ID (`fdis_...`).
516516
from line 526
526526
527527 The version of the Claude API you want to use.
528528
529 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
529 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
530530
531531#### Returns
532532
from line 709
709709
710710**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}`
711711
712**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
712**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
713713
714714Partially update a federation issuer.
715715
from line 732
732732
733733 The version of the Claude API you want to use.
734734
735 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
735 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
736736
737737#### Body parameters
738738
from line 995
995995
996996**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive`
997997
998**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
998**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
999999
10001000Archive a federation issuer.
10011001
from line 1016
10161016
10171017 The version of the Claude API you want to use.
10181018
1019 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1019 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10201020
10211021#### Returns
10221022
from line 1202
12021202
12031203**POST** `/v1/organizations/federation_rules`
12041204
1205**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1205**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
12061206
12071207Create a federation rule owned by your organization.
12081208
from line 1226
12261226
12271227 The version of the Claude API you want to use.
12281228
1229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
12301230
12311231#### Body parameters
12321232
from line 1508
15081508
15091509**GET** `/v1/organizations/federation_rules`
15101510
1511**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1511**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
15121512
15131513List federation rules in your organization.
15141514
from line 1543
15431543
15441544 The version of the Claude API you want to use.
15451545
1546 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1546 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15471547
15481548#### Returns
15491549
from line 1730
17301730
17311731**GET** `/v1/organizations/federation_rules/{federation_rule_id}`
17321732
1733**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1733**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
17341734
17351735Retrieve a federation rule by its ID (`fdrl_...`).
17361736
from line 1746
17461746
17471747 The version of the Claude API you want to use.
17481748
1749 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1749 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
17501750
17511751#### Returns
17521752
from line 1935
19351935
19361936**POST** `/v1/organizations/federation_rules/{federation_rule_id}`
19371937
1938**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1938**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
19391939
19401940Partially update a federation rule.
19411941
from line 1967
19671967
19681968 The version of the Claude API you want to use.
19691969
1970 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1970 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
19711971
19721972#### Body parameters
19731973
from line 2236
22362236
22372237**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive`
22382238
2239**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2239**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
22402240
22412241Archive a federation rule.
22422242
from line 2260
22602260
22612261 The version of the Claude API you want to use.
22622262
2263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2263 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
22642264
22652265#### Returns
22662266
from line 2452
24522452
24532453**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
24542454
2455**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2455**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
24562456
24572457Enable a federation rule for a workspace.
24582458
from line 2477
24772477
24782478 The version of the Claude API you want to use.
24792479
2480 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2480 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
24812481
24822482#### Body parameters
24832483
from line 2544
25442544
25452545**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
25462546
2547**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2547**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
25482548
25492549List workspaces where this federation rule is enabled.
25502550
from line 2578
25782578
25792579 The version of the Claude API you want to use.
25802580
2581 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2581 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
25822582
25832583#### Returns
25842584
from line 2644
26442644
26452645**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}`
26462646
2647**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2647**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
26482648
26492649Disable a federation rule for a workspace.
26502650
from line 2669
26692669
26702670 The version of the Claude API you want to use.
26712671
2672 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2672 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
26732673
26742674#### Returns
26752675
api/organization/federation/issuers Changed · +10 / -10 lines
from line 9
99
1010**POST** `/v1/organizations/federation_issuers`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414Register an OIDC issuer that Anthropic will trust for workload identity
1515federation in your organization.
from line 29
2929
3030 The version of the Claude API you want to use.
3131
32 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
32 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3333
3434### Body parameters
3535
from line 291
291291
292292**GET** `/v1/organizations/federation_issuers`
293293
294**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
294**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
295295
296296List federation issuers in your organization.
297297
from line 321
321321
322322 The version of the Claude API you want to use.
323323
324 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
324 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
325325
326326### Returns
327327
from line 508
508508
509509**GET** `/v1/organizations/federation_issuers/{federation_issuer_id}`
510510
511**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
511**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
512512
513513Retrieve a federation issuer by its ID (`fdis_...`).
514514
from line 524
524524
525525 The version of the Claude API you want to use.
526526
527 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
527 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
528528
529529### Returns
530530
from line 707
707707
708708**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}`
709709
710**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
710**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
711711
712712Partially update a federation issuer.
713713
from line 730
730730
731731 The version of the Claude API you want to use.
732732
733 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
733 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
734734
735735### Body parameters
736736
from line 993
993993
994994**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive`
995995
996**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
996**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
997997
998998Archive a federation issuer.
999999
from line 1014
10141014
10151015 The version of the Claude API you want to use.
10161016
1017 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1017 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10181018
10191019### Returns
10201020
api/organization/federation/rules Changed · +16 / -16 lines
from line 9
99
1010**POST** `/v1/organizations/federation_rules`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414Create a federation rule owned by your organization.
1515
from line 33
3333
3434 The version of the Claude API you want to use.
3535
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
36 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3737
3838### Body parameters
3939
from line 315
315315
316316**GET** `/v1/organizations/federation_rules`
317317
318**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
318**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
319319
320320List federation rules in your organization.
321321
from line 350
350350
351351 The version of the Claude API you want to use.
352352
353 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
353 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
354354
355355### Returns
356356
from line 537
537537
538538**GET** `/v1/organizations/federation_rules/{federation_rule_id}`
539539
540**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
540**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
541541
542542Retrieve a federation rule by its ID (`fdrl_...`).
543543
from line 553
553553
554554 The version of the Claude API you want to use.
555555
556 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
556 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
557557
558558### Returns
559559
from line 742
742742
743743**POST** `/v1/organizations/federation_rules/{federation_rule_id}`
744744
745**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
745**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
746746
747747Partially update a federation rule.
748748
from line 774
774774
775775 The version of the Claude API you want to use.
776776
777 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
777 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
778778
779779### Body parameters
780780
from line 1043
10431043
10441044**POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive`
10451045
1046**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1046**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
10471047
10481048Archive a federation rule.
10491049
from line 1067
10671067
10681068 The version of the Claude API you want to use.
10691069
1070 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1070 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10711071
10721072### Returns
10731073
from line 1472
14721472
14731473**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
14741474
1475**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1475**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
14761476
14771477Enable a federation rule for a workspace.
14781478
from line 1497
14971497
14981498 The version of the Claude API you want to use.
14991499
1500 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1500 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15011501
15021502#### Body parameters
15031503
from line 1564
15641564
15651565**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
15661566
1567**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1567**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
15681568
15691569List workspaces where this federation rule is enabled.
15701570
from line 1598
15981598
15991599 The version of the Claude API you want to use.
16001600
1601 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1601 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16021602
16031603#### Returns
16041604
from line 1664
16641664
16651665**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}`
16661666
1667**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1667**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
16681668
16691669Disable a federation rule for a workspace.
16701670
from line 1689
16891689
16901690 The version of the Claude API you want to use.
16911691
1692 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1692 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16931693
16941694#### Returns
16951695
api/organization/federation/rules/workspaces Changed · +6 / -6 lines
from line 9
99
1010**POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414Enable a federation rule for a workspace.
1515
from line 34
3434
3535 The version of the Claude API you want to use.
3636
37 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
37 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3838
3939### Body parameters
4040
from line 101
101101
102102**GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces`
103103
104**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
104**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
105105
106106List workspaces where this federation rule is enabled.
107107
from line 135
135135
136136 The version of the Claude API you want to use.
137137
138 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
138 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
139139
140140### Returns
141141
from line 201
201201
202202**DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}`
203203
204**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
204**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
205205
206206Disable a federation rule for a workspace.
207207
from line 226
226226
227227 The version of the Claude API you want to use.
228228
229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
230230
231231### Returns
232232
api/organization/invites Changed · +4 / -4 lines
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424### Body parameters
2525
from line 210
210210
211211 The version of the Claude API you want to use.
212212
213 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
213 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
214214
215215### Returns
216216
from line 351
351351
352352 The version of the Claude API you want to use.
353353
354 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
354 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
355355
356356### Returns
357357
from line 473
473473
474474 The version of the Claude API you want to use.
475475
476 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
476 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
477477
478478### Returns
479479
api/organization/service_accounts Changed · +16 / -16 lines
from line 9
99
1010**POST** `/v1/organizations/service_accounts`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414Create a service account.
1515
from line 27
2727
2828 The version of the Claude API you want to use.
2929
30 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
30 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3131
3232### Body parameters
3333
from line 148
148148
149149**GET** `/v1/organizations/service_accounts`
150150
151**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
151**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
152152
153153List service accounts in the caller's organization.
154154
from line 180
180180
181181 The version of the Claude API you want to use.
182182
183 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
183 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
184184
185185### Returns
186186
from line 279
279279
280280**GET** `/v1/organizations/service_accounts/{service_account_id}`
281281
282**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
282**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
283283
284284Retrieve a service account by its ID (`svac_...`).
285285
from line 295
295295
296296 The version of the Claude API you want to use.
297297
298 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
298 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
299299
300300### Returns
301301
from line 390
390390
391391**POST** `/v1/organizations/service_accounts/{service_account_id}`
392392
393**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
393**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
394394
395395Update a service account.
396396
from line 411
411411
412412 The version of the Claude API you want to use.
413413
414 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
414 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
415415
416416### Body parameters
417417
from line 524
524524
525525**POST** `/v1/organizations/service_accounts/{service_account_id}/archive`
526526
527**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
527**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
528528
529529Archive a service account.
530530
from line 545
545545
546546 The version of the Claude API you want to use.
547547
548 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
548 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
549549
550550### Returns
551551
from line 746
746746
747747**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
748748
749**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
749**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
750750
751751Add a service account to a workspace with the given `workspace_role`.
752752
from line 769
769769
770770 The version of the Claude API you want to use.
771771
772 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
772 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
773773
774774#### Body parameters
775775
from line 857
857857
858858**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
859859
860**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
860**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
861861
862862List the workspaces a service account is a member of.
863863
from line 899
899899
900900 The version of the Claude API you want to use.
901901
902 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
902 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
903903
904904#### Returns
905905
from line 973
973973
974974**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
975975
976**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
976**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
977977
978978Remove a service account from a workspace.
979979
from line 1001
10011001
10021002 The version of the Claude API you want to use.
10031003
1004 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1004 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
10051005
10061006#### Returns
10071007
api/organization/service_accounts/workspaces Changed · +6 / -6 lines
from line 9
99
1010**POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414Add a service account to a workspace with the given `workspace_role`.
1515
from line 32
3232
3333 The version of the Claude API you want to use.
3434
35 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
35 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
3636
3737### Body parameters
3838
from line 120
120120
121121**GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces`
122122
123**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
123**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
124124
125125List the workspaces a service account is a member of.
126126
from line 162
162162
163163 The version of the Claude API you want to use.
164164
165 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
165 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
166166
167167### Returns
168168
from line 236
236236
237237**DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}`
238238
239**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
239**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
240240
241241Remove a service account from a workspace.
242242
from line 264
264264
265265 The version of the Claude API you want to use.
266266
267 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
267 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
268268
269269### Returns
270270
api/organization/users Changed · +4 / -4 lines
from line 47
4747
4848 The version of the Claude API you want to use.
4949
50 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
50 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
5151
5252### Returns
5353
from line 159
159159
160160 The version of the Claude API you want to use.
161161
162 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
162 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
163163
164164### Returns
165165
from line 252
252252
253253 The version of the Claude API you want to use.
254254
255 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
255 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
256256
257257### Body parameters
258258
from line 367
367367
368368 The version of the Claude API you want to use.
369369
370 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
370 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
371371
372372### Returns
373373
api/organization/workspaces Changed · +21 / -21 lines
from line 47
4747
4848 The version of the Claude API you want to use.
4949
50 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
50 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
5151
5252### Returns
5353
from line 208
208208
209209 The version of the Claude API you want to use.
210210
211 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
211 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
212212
213213### Body parameters
214214
from line 426
426426
427427 The version of the Claude API you want to use.
428428
429 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
429 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
430430
431431### Returns
432432
from line 572
572572
573573 The version of the Claude API you want to use.
574574
575 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
575 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
576576
577577### Body parameters
578578
from line 783
783783
784784 The version of the Claude API you want to use.
785785
786 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
786 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
787787
788788### Returns
789789
from line 1226
12261226
12271227 The version of the Claude API you want to use.
12281228
1229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1229 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
12301230
12311231#### Returns
12321232
from line 1470
14701470
14711471 The version of the Claude API you want to use.
14721472
1473 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1473 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
14741474
14751475#### Returns
14761476
from line 1562
15621562
15631563 The version of the Claude API you want to use.
15641564
1565 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1565 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
15661566
15671567#### Body parameters
15681568
from line 1662
16621662
16631663 The version of the Claude API you want to use.
16641664
1665 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1665 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
16661666
16671667#### Returns
16681668
from line 1739
17391739
17401740 The version of the Claude API you want to use.
17411741
1742 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1742 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
17431743
17441744#### Body parameters
17451745
from line 1836
18361836
18371837 The version of the Claude API you want to use.
18381838
1839 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1839 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
18401840
18411841#### Returns
18421842
from line 1881
18811881
18821882**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
18831883
1884**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1884**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
18851885
18861886List the service accounts that are members of a workspace.
18871887
from line 1916
19161916
19171917 The version of the Claude API you want to use.
19181918
1919 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
1919 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
19201920
19211921#### Returns
19221922
from line 1990
19901990
19911991**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
19921992
1993**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
1993**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
19941994
19951995Add a service account to a workspace with the given `workspace_role`.
19961996
from line 2015
20152015
20162016 The version of the Claude API you want to use.
20172017
2018 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2018 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
20192019
20202020#### Body parameters
20212021
from line 2103
21032103
21042104**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
21052105
2106**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2106**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
21072107
21082108Retrieve a service account's membership in a workspace.
21092109
from line 2130
21302130
21312131 The version of the Claude API you want to use.
21322132
2133 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2133 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
21342134
21352135#### Returns
21362136
from line 2195
21952195
21962196**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
21972197
2198**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2198**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
21992199
22002200Change a service account's role in a workspace.
22012201
from line 2222
22222222
22232223 The version of the Claude API you want to use.
22242224
2225 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2225 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
22262226
22272227#### Body parameters
22282228
from line 2305
23052305
23062306**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
23072307
2308**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
2308**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
23092309
23102310Remove a service account from a workspace.
23112311
from line 2331
23312331
23322332 The version of the Claude API you want to use.
23332333
2334 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
2334 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
23352335
23362336#### Returns
23372337
api/organization/workspaces/members Changed · +5 / -5 lines
from line 41
4141
4242 The version of the Claude API you want to use.
4343
44 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
44 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
4545
4646### Returns
4747
from line 133
133133
134134 The version of the Claude API you want to use.
135135
136 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
136 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
137137
138138### Body parameters
139139
from line 233
233233
234234 The version of the Claude API you want to use.
235235
236 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
236 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
237237
238238### Returns
239239
from line 310
310310
311311 The version of the Claude API you want to use.
312312
313 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
313 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
314314
315315### Body parameters
316316
from line 407
407407
408408 The version of the Claude API you want to use.
409409
410 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
410 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
411411
412412### Returns
413413
api/organization/workspaces/service_accounts Changed · +10 / -10 lines
from line 9
99
1010**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
1111
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
12**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
1313
1414List the service accounts that are members of a workspace.
1515
from line 44
4444
4545 The version of the Claude API you want to use.
4646
47 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
47 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
4848
4949### Returns
5050
from line 118
118118
119119**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts`
120120
121**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
121**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
122122
123123Add a service account to a workspace with the given `workspace_role`.
124124
from line 143
143143
144144 The version of the Claude API you want to use.
145145
146 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
146 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
147147
148148### Body parameters
149149
from line 231
231231
232232**GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
233233
234**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
234**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
235235
236236Retrieve a service account's membership in a workspace.
237237
from line 258
258258
259259 The version of the Claude API you want to use.
260260
261 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
261 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
262262
263263### Returns
264264
from line 323
323323
324324**POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
325325
326**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
326**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
327327
328328Change a service account's role in a workspace.
329329
from line 350
350350
351351 The version of the Claude API you want to use.
352352
353 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
353 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
354354
355355### Body parameters
356356
from line 433
433433
434434**DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}`
435435
436**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](/docs/en/manage-claude/wif-admin-api).
436**Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http).
437437
438438Remove a service account from a workspace.
439439
from line 459
459459
460460 The version of the Claude API you want to use.
461461
462 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
462 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
463463
464464### Returns
465465
api/skills Changed · +8 / -8 lines
from line 17
1717
1818 The version of the Claude API you want to use.
1919
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
20 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2121
2222- `"anthropic-workspace-id": optional string`
2323
from line 172
172172
173173 The version of the Claude API you want to use.
174174
175 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
175 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
176176
177177- `"anthropic-workspace-id": optional string`
178178
from line 307
307307
308308 The version of the Claude API you want to use.
309309
310 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
310 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
311311
312312- `"anthropic-workspace-id": optional string`
313313
from line 429
429429
430430 The version of the Claude API you want to use.
431431
432 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
432 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
433433
434434- `"anthropic-workspace-id": optional string`
435435
from line 608
608608
609609 The version of the Claude API you want to use.
610610
611 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
611 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
612612
613613- `"anthropic-workspace-id": optional string`
614614
from line 723
723723
724724 The version of the Claude API you want to use.
725725
726 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
726 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
727727
728728- `"anthropic-workspace-id": optional string`
729729
from line 833
833833
834834 The version of the Claude API you want to use.
835835
836 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
836 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
837837
838838- `"anthropic-workspace-id": optional string`
839839
from line 930
930930
931931 The version of the Claude API you want to use.
932932
933 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
933 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
934934
935935- `"anthropic-workspace-id": optional string`
936936
api/skills/versions Changed · +4 / -4 lines
from line 25
2525
2626 The version of the Claude API you want to use.
2727
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
28 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2929
3030- `"anthropic-workspace-id": optional string`
3131
from line 140
140140
141141 The version of the Claude API you want to use.
142142
143 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
143 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
144144
145145- `"anthropic-workspace-id": optional string`
146146
from line 250
250250
251251 The version of the Claude API you want to use.
252252
253 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
253 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
254254
255255- `"anthropic-workspace-id": optional string`
256256
from line 347
347347
348348 The version of the Claude API you want to use.
349349
350 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
350 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
351351
352352- `"anthropic-workspace-id": optional string`
353353
api/beta/agents/create Changed · +2 / -2 lines
from line 129
129129
130130- `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
131131
132 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control
132 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control
133133
134134 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
135135
from line 297
297297
298298- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams`
299299
300 MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).
300 MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector?sdk_languages=http).
301301
302302 - `type: "url"`
303303
api/beta/agents/update Changed · +2 / -2 lines
from line 141
141141
142142- `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams or null`
143143
144 MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector).
144 MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector?sdk_languages=http).
145145
146146 - `type: "url"`
147147
from line 163
163163
164164- `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams`
165165
166 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
166 Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared.
167167
168168 - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string`
169169
api/beta/environments/archive Changed · +1 / -1 lines
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424- `"anthropic-beta": optional array of AnthropicBeta`
2525
api/beta/environments/create Changed · +1 / -1 lines
from line 15
1515
1616 The version of the Claude API you want to use.
1717
18 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
18 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
1919
2020- `"anthropic-beta": optional array of AnthropicBeta`
2121
api/beta/environments/delete Changed · +1 / -1 lines
from line 19
1919
2020 The version of the Claude API you want to use.
2121
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning).
22 Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http).
2323
2424- `"anthropic-beta": optional array of AnthropicBeta`
2525