1,488 pages for read.

intro Claude Developer Platform · in the page intro …d can use Workload Identity Federation instead of a static key. [Read the authentication guide](https://platform.claude.com/docs/en/manage-claude/authentication) </Step> <Step title="Underst… access-transparency Claude Developer Platform · in the page manage-claude/access-transparency …ation's activity:** Your API calls, admin actions, and Compliance API reads are covered by standard [Activity Feed](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed) event ty… access-transparency-log Claude Developer Platform · in the page manage-claude/access-transparency-log …ns one for your organization once Access Transparency is enabled. You read it through the Compliance API with the same key and scope you use for the [Activity Feed](https://platform.claude.com/docs/en… admin-api Claude Developer Platform · in the page manage-claude/admin-api …them. They also get Enterprise-only endpoints: group and custom-role reads, and [spend limits](https://platform.claude.com/docs/en/manage-claude/spend-limits-api). The [Plugins API](https://platform.… admin-api-keys Claude Developer Platform · in the page manage-claude/admin-api-keys …e primary owner can combine scopes from different APIs (for example, `read:analytics` and `read:spend_limits`) on a single key. </Step> <Step title="Copy and store the secret"> Copy the displ… analytics-api Claude Developer Platform · in the page manage-claude/analytics-api …public API access, then create an Analytics API key. Keys carry the `read:analytics` scope. Copy the displayed secret and store it in your secrets manager. </Step> <Step title="Call the API">… api-and-data-retention Claude Developer Platform · in the page manage-claude/api-and-data-retention …data, including information about zero data retention (ZDR) and HIPAA-ready API access. --- This page covers the Claude API (`api.anthropic.com`), Claude Platform on AWS, [Claude in Microsoft Foundry… authentication Claude Developer Platform · in the page manage-claude/authentication …ing shared. Move to Workload Identity Federation when your workload already has a platform-issued identity you can federate. Use App Attest for iOS and macOS apps you distribute to end users. ## API… First request Claude Developer Platform · in the page manage-claude/claude-code-analytics-api …put:** Input and output token counts for this model * **tokens.cache\_read/cache\_creation:** Cache-related token usage for this model * **estimated\_cost.amount:** Estimated cost in cents USD for thi… cmek Claude Developer Platform · in the page manage-claude/cmek …requests to that workspace. If you attach a key to a workspace that already receives requests, your key can take up to a day to take effect. Data written before then, like existing data, is encrypted… cmek-admin-api Claude Developer Platform · in the page manage-claude/cmek-admin-api …latform.claude.com/docs/en/manage-claude/admin-api-keys). The samples read it from `ANTHROPIC_API_KEY`. * You've created your key in [AWS KMS](https://platform.claude.com/docs/en/manage-claude/cmek-aw… cmek-aws-kms Claude Developer Platform · in the page manage-claude/cmek-aws-kms …their compartment IDs. If you're replacing the policy on a key that already protects Claude data, [add one more statement](https://platform.claude.com/docs/en/manage-claude/cmek-troubleshooting#existi… cmek-aws-kms-workspaces Claude Developer Platform · in the page manage-claude/cmek-aws-kms-workspaces …the compartment ID of every workspace that uses the key. A key that already protects data [needs one more statement](https://platform.claude.com/docs/en/manage-claude/cmek-troubleshooting#existing-dat… cmek-azure-key-vault Claude Developer Platform · in the page manage-claude/cmek-azure-key-vault …/cmek-azure-key-vault#prerequisites) in lowercase. To use a key you already have, [add the organization tag](https://platform.claude.com/docs/en/manage-claude/cmek-azure-key-vault#organization-tag) fi… cmek-claude-platform-on-aws Claude Developer Platform · in the page manage-claude/cmek-claude-platform-on-aws …nt. If you add the condition later, list every workspace the key is already attached to. To narrow access further, use the key policy, not IP-based restrictions. Add an `aws:SourceArn` condition to b… cmek-coverage-claude-enterprise Claude Developer Platform · in the page manage-claude/cmek-coverage-claude-enterprise …ed on in organizations that also use ZDR. In organizations with HIPAA readiness, an Owner must first accept the terms for using them. | | Artifact publishing and sharing… cmek-data-retention Claude Developer Platform · in the page manage-claude/cmek-data-retention …g metadata is retained under Anthropic-managed encryption and remains readable after key revocation. These are records derived from Anthropic's automated safety scans, such as pattern identifiers and… cmek-google-cloud-kms Claude Developer Platform · in the page manage-claude/cmek-google-cloud-kms …docs.cloud.google.com/logging/docs/audit/configure-data-access) (Data Read and Data Write) are on, so Cloud Logging records Anthropic's use of your key. They're off by default. * If your Google Cloud… cmek-how-it-works Claude Developer Platform · in the page manage-claude/cmek-how-it-works …, or wraps, those data keys. This is envelope encryption. To write or read data, Anthropic asks your key management service (KMS) to wrap or unwrap a data key. Data keys cross between Anthropic and y… cmek-key-lifecycle Claude Developer Platform · in the page manage-claude/cmek-key-lifecycle …flight during that hour might still succeed. After that, Claude can't read or write the data the key protects, and requests fail.… cmek-troubleshooting Claude Developer Platform · in the page manage-claude/cmek-troubleshooting …--key-id <KEY_ARN> \ --policy-name default ``` ### A key that already protects data If you're [replacing the policy on a key](https://platform.claude.com/docs/en/manage-claude/cmek-aws-kms-work… Fetch the first page (newest activities first). Claude Developer Platform · in the page manage-claude/compliance-activity-feed …laude/compliance-api-access). </Note> <Check> **Required scope:** `read:compliance_activities` on the Compliance Access Key or Admin API key. Both Compliance Access Keys (`sk-ant-api01-...`) car… compliance-api Claude Developer Platform · in the page manage-claude/compliance-api …he most recent activity event in your organization. Any key with the `read:compliance_activities` scope can make it. To create a key and grant it that scope, see [Set up the Compliance API](https://pl… compliance-api-access Claude Developer Platform · in the page manage-claude/compliance-api-access …iance-activity-feed) only. <Warning> A Compliance Access Key with `read:compliance_user_data` can read every chat, file, project, and session transcript in every linked organization, including cont… WARNING: This operation PERMANENTLY deletes the chat, all of its messages, Claude Developer Platform · in the page manage-claude/compliance-content-data …laude/compliance-api-access). </Note> <Check> **Required scope:** `read:compliance_user_data` on the Compliance Access Key. The delete endpoints also require `delete:compliance_user_data`. **Pre… compliance-errors Claude Developer Platform · in the page manage-claude/compliance-errors …: "permission_error", "message": "Missing required scopes. Got: ['read:compliance_activities'] Needed one of: ['read:compliance_user_data', 'read:org_audit']" } } ``` On this page, local sessio… compliance-faq Claude Developer Platform · in the page manage-claude/compliance-faq …ack on resumes recording from that point forward; activity that was already recorded is not deleted. </Accordion> <Accordion title="Does turning the Compliance API off delete events that were alr… before_id is the first_id from a previous response Claude Developer Platform · in the page manage-claude/compliance-integration-patterns …laude/compliance-api-access). </Note> <Check> **Required scope:** `read:compliance_activities` on the Compliance Access Key or Admin API key. </Check> A production Compliance API integration makes… compliance-org-data Claude Developer Platform · in the page manage-claude/compliance-org-data …s under your parent organization (their users, roles, and groups) and read each organization's effective settings through the Compliance API. --- <Note> To enable the Compliance API, see [Set up th… compliance-sessions Claude Developer Platform · in the page manage-claude/compliance-sessions …in beta. The endpoints work with the same Compliance Access Key and `read:compliance_user_data` scope as the [chat, file, and project endpoints](https://platform.claude.com/docs/en/manage-claude/comp… data-residency Claude Developer Platform · in the page manage-claude/data-residency …its default inference geo. The Claude Console shows both settings as read-only. For US-only inference, set `inference_geo: "us"` on each request. </Note> ## Workspace geo Workspace geo is set when… inference-hooks Claude Developer Platform · in the page manage-claude/inference-hooks …content from what the app sends next, including any file Claude would read again. The steps depend on the app: * **claude.ai, including Claude Desktop and the mobile apps.** The user edits the denie… inference-hooks-configuration Claude Developer Platform · in the page manage-claude/inference-hooks-configuration …d privacy** rather than as its own entry in the settings nav, so its breadcrumb reads **Data and privacy / Inference hooks**. Until you save an endpoint, the page warns that prompts aren't being inspe… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …verdict round trip The smallest working integration is a server that reads each request and allows it. Run one of the following servers and expose it at a public `https://` URL. For example, put it b… opentelemetry Claude Developer Platform · in the page manage-claude/opentelemetry …y.io/). You can view these traces in the observability platform you already have. Use them to debug failed or slow requests, track token spend and latency, and build evals from real traffic. You can a… api Claude Developer Platform · in the page manage-claude/opentelemetry/api …pplication's traces, so that they nest under your own spans. The API reads each request's trace context from the W3C [`traceparent` header](https://www.w3.org/TR/trace-context/). If the sampled flag… sdk Claude Developer Platform · in the page manage-claude/opentelemetry/sdk …, or update it to at least the following version if your build file already declares it: <CodeGroup exclude="shell, python, typescript, csharp, go, php, ruby"> ```kotlin Gradle implem… organization-webhooks Claude Developer Platform · in the page manage-claude/organization-webhooks …API that has organization webhooks turned on and doesn't have [HIPAA readiness](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#hipaa-readiness) enabled. To request access, c… plugins-api Claude Developer Platform · in the page manage-claude/plugins-api …key required** These endpoints require an Admin API key with the `read:plugins` scope (for `GET` endpoints, including archive downloads) or the `write:plugins` scope (for `POST` and `DELETE` endpo… rate-limits-api Claude Developer Platform · in the page manage-claude/rate-limits-api …Console. Use this API to: * **Keep gateways and proxies in sync:** Read your current limits at startup and on a schedule instead of hardcoding values that drift when Anthropic adjusts them. * **Pow… spend-limits-api Claude Developer Platform · in the page manage-claude/spend-limits-api …key required** These endpoints require an Admin API key with the `read:spend_limits` scope (for `GET` endpoints) or the `write:spend_limits` scope (for `POST` and `DELETE` endpoints). See [Create… First request Claude Developer Platform · in the page manage-claude/usage-cost-api …lies to. ## Partner solutions Leading observability platforms offer ready-to-use integrations for monitoring your Claude API usage and cost, without writing custom code. These integrations provide d… user-management Claude Developer Platform · in the page manage-claude/user-management …mbers and change roles, send and withdraw invites, manage groups, and read custom roles." --- This page covers managing the people in your **Claude Enterprise** (claude.ai) organization programmatica… user-profiles Claude Developer Platform · in the page manage-claude/user-profiles …w profile, even when `reference_id` matches an existing one. If you already have end customers without profiles, see the guidance on registering an existing customer base later in this section. The f… user-profiles-verification-portal Claude Developer Platform · in the page manage-claude/user-profiles-verification-portal …ck a button in your product, not ahead of time in an email they might read later. They can open the link more than once until it expires. If it has expired, create a new one: each call returns a fresh… wif-admin-api Claude Developer Platform · in the page manage-claude/wif-admin-api …nd (it refreshes the token automatically). The SDK and the `ant` CLI read `ANTHROPIC_AUTH_TOKEN` automatically; leave `ANTHROPIC_API_KEY` unset in the same shell, because these endpoints reject API k… aws Claude Developer Platform · in the page manage-claude/wif-providers/aws …_ID, # ANTHROPIC_SERVICE_ACCOUNT_ID, and ANTHROPIC_WORKSPACE_ID are read from the environment ant messages create \ --model claude-opus-5-5 \ --max-tokens 1024 \ --message '{role: user… Create the app registration that represents the Claude API audience. Claude Developer Platform · in the page manage-claude/wif-providers/azure …| You want defense in depth. The issuer URL already pins the tenant.… gcp Claude Developer Platform · in the page manage-claude/wif-providers/gcp …ce account's opaque numeric unique ID. The `email` claim is the human-readable service account address. Match on both `sub` and `email` in your federation rule. </Tab> <Tab title="GKE with Worklo… github-actions Claude Developer Platform · in the page manage-claude/wif-providers/github-actions …low or job level: ```yaml permissions: id-token: write contents: read ``` Inside the job, the runner exposes two environment variables: `ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUE…