api-20261014T203720Z / page 11 of 12 / documentation capture

api/beta/vaults/archive Changed · +2 / -0 lines

from line 125

125125

126126 - `"spend-limit-reads-2026-09-26"`

127127

128 - `"telemetry-destinations-2026-08-11"`

129

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

129131

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

api/beta/vaults/create Changed · +2 / -0 lines

from line 119

119119

120120 - `"spend-limit-reads-2026-09-26"`

121121

122 - `"telemetry-destinations-2026-08-11"`

123

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

123125

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

api/beta/vaults/credentials/archive Changed · +2 / -0 lines

from line 129

129129

130130 - `"spend-limit-reads-2026-09-26"`

131131

132 - `"telemetry-destinations-2026-08-11"`

133

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

133135

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

api/beta/vaults/credentials/create Changed · +2 / -0 lines

from line 125

125125

126126 - `"spend-limit-reads-2026-09-26"`

127127

128 - `"telemetry-destinations-2026-08-11"`

129

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

129131

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

api/beta/vaults/credentials/delete Changed · +2 / -0 lines

from line 129

129129

130130 - `"spend-limit-reads-2026-09-26"`

131131

132 - `"telemetry-destinations-2026-08-11"`

133

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

133135

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

api/beta/vaults/credentials/list Changed · +2 / -0 lines

from line 141

141141

142142 - `"spend-limit-reads-2026-09-26"`

143143

144 - `"telemetry-destinations-2026-08-11"`

145

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

145147

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

api/beta/vaults/credentials/mcp_oauth_validate Changed · +2 / -0 lines

from line 129

129129

130130 - `"spend-limit-reads-2026-09-26"`

131131

132 - `"telemetry-destinations-2026-08-11"`

133

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

133135

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

api/beta/vaults/credentials/retrieve Changed · +2 / -0 lines

from line 129

129129

130130 - `"spend-limit-reads-2026-09-26"`

131131

132 - `"telemetry-destinations-2026-08-11"`

133

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

133135

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

api/beta/vaults/credentials/update Changed · +2 / -0 lines

from line 129

129129

130130 - `"spend-limit-reads-2026-09-26"`

131131

132 - `"telemetry-destinations-2026-08-11"`

133

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

133135

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

api/beta/vaults/delete Changed · +2 / -0 lines

from line 125

125125

126126 - `"spend-limit-reads-2026-09-26"`

127127

128 - `"telemetry-destinations-2026-08-11"`

129

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

129131

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

api/beta/vaults/list Changed · +2 / -0 lines

from line 135

135135

136136 - `"spend-limit-reads-2026-09-26"`

137137

138 - `"telemetry-destinations-2026-08-11"`

139

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

139141

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

api/beta/vaults/retrieve Changed · +2 / -0 lines

from line 125

125125

126126 - `"spend-limit-reads-2026-09-26"`

127127

128 - `"telemetry-destinations-2026-08-11"`

129

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

129131

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

api/beta/vaults/update Changed · +2 / -0 lines

from line 125

125125

126126 - `"spend-limit-reads-2026-09-26"`

127127

128 - `"telemetry-destinations-2026-08-11"`

129

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

129131

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

api/completions Changed · +2 / -0 lines

from line 139

139139

140140 - `"spend-limit-reads-2026-09-26"`

141141

142 - `"telemetry-destinations-2026-08-11"`

143

142144### Body parameters

143145

144146- `max_tokens_to_sample: number`

api/completions/create Changed · +2 / -0 lines

from line 137

137137

138138 - `"spend-limit-reads-2026-09-26"`

139139

140 - `"telemetry-destinations-2026-08-11"`

141

140142## Body parameters

141143

142144- `max_tokens_to_sample: number`

api/models Changed · +4 / -0 lines

from line 165

165165

166166 - `"spend-limit-reads-2026-09-26"`

167167

168 - `"telemetry-destinations-2026-08-11"`

169

168170### Returns

169171

170172- `data: array of ModelInfo`

from line 615

613615 - `"ce-plugins-2026-09-01"`

614616

615617 - `"spend-limit-reads-2026-09-26"`

618

619 - `"telemetry-destinations-2026-08-11"`

616620

617621### Returns

618622

api/models/list Changed · +2 / -0 lines

from line 163

163163

164164 - `"spend-limit-reads-2026-09-26"`

165165

166 - `"telemetry-destinations-2026-08-11"`

167

166168## Returns

167169

168170- `data: array of ModelInfo`

api/models/retrieve Changed · +2 / -0 lines

from line 139

139139

140140 - `"spend-limit-reads-2026-09-26"`

141141

142 - `"telemetry-destinations-2026-08-11"`

143

142144## Returns

143145

144146- `ModelInfo object`

api/organization Changed · +2 / -2 lines

from line 4325

43254325

43264326 Role for the invited User.

43274327

4328 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

4328 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`.

43294329

43304330 - `"billing"`

43314331

from line 5986

59865986

59875987 New role for the User.

59885988

5989 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

5989 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; changing a User's role to `managed` requires the `write:rbac_groups` scope in addition to `write:members`.

59905990

59915991 - `"billing"`

59925992

api/organization/invites Changed · +1 / -1 lines

from line 33

3333

3434 Role for the invited User.

3535

36 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

36 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`.

3737

3838 - `"billing"`

3939

api/organization/invites/create Changed · +1 / -1 lines

from line 31

3131

3232 Role for the invited User.

3333

34 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

34 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`.

3535

3636 - `"billing"`

3737

api/organization/users Changed · +1 / -1 lines

from line 260

260260

261261 New role for the User.

262262

263 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

263 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; changing a User's role to `managed` requires the `write:rbac_groups` scope in addition to `write:members`.

264264

265265 - `"billing"`

266266

api/organization/users/update Changed · +1 / -1 lines

from line 29

2929

3030 New role for the User.

3131

32 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`.

32 The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; changing a User's role to `managed` requires the `write:rbac_groups` scope in addition to `write:members`.

3333

3434 - `"billing"`

3535

api/overview Changed · +2 / -2 lines

from line 15

1515To use the Claude API, you'll need:

1616

1717* A [Claude Console account](https://platform.claude.com)

18* An [API key](https://platform.claude.com/settings/keys), or a configured [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation) rule

18* An [API key](https://platform.claude.com/settings/keys) from the Console, or a configured [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation) rule

1919

2020For step-by-step setup instructions, see [Get started](https://platform.claude.com/docs/en/get-started).

2121

from line 56

5656

5757### Getting API keys

5858

59The API is made available through the web [Console](https://platform.claude.com/). You can use [playground](https://platform.claude.com/playground) to try out the API in the browser and then generate API keys in [Account Settings](https://platform.claude.com/settings/keys) (see [Get your Claude API key](https://platform.claude.com/docs/en/get-api-key)). You choose each key's type (see [Key types](https://platform.claude.com/docs/en/manage-claude/authentication#key-types)) and its [expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration) when you create it. Use [workspaces](https://platform.claude.com/settings/workspaces) to separate environments and [control spend](https://platform.claude.com/docs/en/api/rate-limits) by use case.

59The API is made available through the web [Console](https://platform.claude.com/). In the Console, you can use [playground](https://platform.claude.com/playground) (`platform.claude.com/playground`) to try out the API in the browser and then generate API keys on the [API keys](https://platform.claude.com/settings/keys) page (`platform.claude.com/settings/keys`). To learn how, see [Get your Claude API key](https://platform.claude.com/docs/en/get-api-key). You choose each key's type (see [Key types](https://platform.claude.com/docs/en/manage-claude/authentication#key-types)) and its [expiration](https://platform.claude.com/docs/en/manage-claude/authentication#key-expiration) when you create it. Use [workspaces](https://platform.claude.com/settings/workspaces) in the Console to separate environments and [control spend](https://platform.claude.com/docs/en/api/rate-limits) by use case.

6060

6161## Client SDKs

6262

cli-sdks-libraries/libraries/apple-foundation-models Changed · +2 / -2 lines

from line 125

125125To set up App Attest, you need your Apple Developer Team ID and the admin, owner, or primary owner role in your organization. Configure your Xcode project and register your app in the [Claude Console](https://platform.claude.com/):

126126

1271271. In Xcode, add the **App Attest** capability to your app target under **Signing & Capabilities**.

1282. In your workspace's settings in the Claude Console, open **App integrations**.

1282. In the Claude Console, go to the [App integrations](https://platform.claude.com/settings/workspaces/default/app-integrations) page (`platform.claude.com/settings/workspaces/default/app-integrations`). Each app integration belongs to one workspace. Select the workspace you want in the workspace picker in the sidebar.

1291293. Click **Create app integration** and enter a name, your Apple Developer Team ID, and one or more bundle IDs (up to 32).

1301304. Copy the client ID (`clid_...`) from the integration's **Overview** tab and pass it to your app's Claude configuration.

131131

from line 133

133133

134134Tokens are scoped to your workspace, expire after one hour, and authorize only [Messages API](https://platform.claude.com/docs/en/api/messages/create) calls. They carry no end-user identity: App Attest identifies your app, not the person using it, so handle any per-user logic in your app.

135135

136To stop a compromised or retired app, revoke its integration: in your workspace's settings in the Claude Console, open **App integrations**, select the integration, and click **Revoke**, then confirm. Revoking an integration revokes its outstanding tokens, and its registered devices can no longer request new ones. Revocation is permanent, so create a new app integration to restore access.

136To stop a compromised or retired app, revoke its integration. In the Claude Console, go to the [App integrations](https://platform.claude.com/settings/workspaces/default/app-integrations) page (`platform.claude.com/settings/workspaces/default/app-integrations`). Each app integration belongs to one workspace. In the workspace picker in the sidebar, select the workspace that holds the integration. Select the integration and click **Revoke**, then confirm. Revoking an integration revokes its outstanding tokens, and its registered devices can no longer request new ones. Revocation is permanent, so create a new app integration to restore access.

137137

138138### Proxy (production)

139139

One read of Claude Developer Platformapi-20261014T203720Z

What this read moved

api/beta/vaults/archive Changed · +2 / -0 lines

api/beta/vaults/create Changed · +2 / -0 lines

api/beta/vaults/credentials/archive Changed · +2 / -0 lines

api/beta/vaults/credentials/create Changed · +2 / -0 lines

api/beta/vaults/credentials/delete Changed · +2 / -0 lines

api/beta/vaults/credentials/list Changed · +2 / -0 lines

api/beta/vaults/credentials/mcp_oauth_validate Changed · +2 / -0 lines

api/beta/vaults/credentials/retrieve Changed · +2 / -0 lines

api/beta/vaults/credentials/update Changed · +2 / -0 lines

api/beta/vaults/delete Changed · +2 / -0 lines

api/beta/vaults/list Changed · +2 / -0 lines

api/beta/vaults/retrieve Changed · +2 / -0 lines

api/beta/vaults/update Changed · +2 / -0 lines

api/completions Changed · +2 / -0 lines

api/completions/create Changed · +2 / -0 lines

api/models Changed · +4 / -0 lines

api/models/list Changed · +2 / -0 lines

api/models/retrieve Changed · +2 / -0 lines

api/organization Changed · +2 / -2 lines

api/organization/invites Changed · +1 / -1 lines

api/organization/invites/create Changed · +1 / -1 lines

api/organization/users Changed · +1 / -1 lines

api/organization/users/update Changed · +1 / -1 lines

api/overview Changed · +2 / -2 lines

cli-sdks-libraries/libraries/apple-foundation-models Changed · +2 / -2 lines