Follow Discord
Sweep 10 Nov 2026 · 02:18Z Build v2.1.322 539 read Stable v2.1.311 Latest v2.1.322 Next v2.1.322 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

989 pages for note.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

go Claude Developer Platform · in the page cli-sdks-libraries/sdks/go …nil { address.ZipCode = 94304 } ``` ### Deserializing parameters <Note> `param.SetJSON` requires SDK v1.20.0 or later. </Note> Parameter types (types ending in `Param`, such as `MessageNewParam… java Claude Developer Platform · in the page cli-sdks-libraries/sdks/java …requires. ## Requirements This library requires Java 8 or later. <Note> The SDK supports Java 8 and later. Code examples in this documentation are written as [JDK 25 compact source files](https:… php Claude Developer Platform · in the page cli-sdks-libraries/sdks/php …ny endpoint, and read undocumented response properties, as follows: <Note> The `extra*` parameters of the same name override the documented parameters. </Note> ```php <?php // ... use Anthropic\Re… For Amazon Bedrock support Claude Developer Platform · in the page cli-sdks-libraries/sdks/python …ssage._request_id) # for example, req_018EeWyXxfu5pfWkrYcMdjWG ``` <Note> Unlike other properties that use an `_` prefix, the `_request_id` property is public. Unless documented otherwise, all oth… Automatically handles tool execution loop Claude Developer Platform · in the page cli-sdks-libraries/sdks/ruby …} ) ``` On timeout, `Anthropic::Errors::APITimeoutError` is raised. Note that requests that time out are retried by default. ## Pagination List methods in the Claude API are paginated. This libra… typescript Claude Developer Platform · in the page cli-sdks-libraries/sdks/typescript …r support by explicitly setting `dangerouslyAllowBrowser` to `true`. Note that React Native is not supported at this time. If you are interested in other runtime environments, open or upvote an issu… get-api-key Claude Developer Platform · in the page get-api-key …never return a key’s secret value, only a partially redacted hint. <Note> The Admin API can’t recover a lost key or give you a key to call the Claude API with. To get a usable API key, create one… home Claude Developer Platform · in the page home …title="What’s new" href="https://platform.claude.com/docs/en/release-notes/overview"> Latest features and updates. </Card> <Card icon="terminal" title="Claude Code" href="https:/… intro Claude Developer Platform · in the page intro …asks involving language, reasoning, analysis, coding, and more. --- <Note> Looking to chat with Claude? Visit [claude.ai](https://claude.ai). </Note> Anthropic offers two ways to build with Claude… access-transparency Claude Developer Platform · in the page manage-claude/access-transparency …at it covers, and how to receive events through the Compliance API. <Note> When Access Transparency is enabled for your organization: * Each human view of your retained data (see [covered conten… access-transparency-log Claude Developer Platform · in the page manage-claude/access-transparency-log …red after it was committed to your organization’s transparency log. <Note> The transparency log is in beta, and its endpoints and response shapes may change during the beta. It is part of Access Tr… admin-api-keys Claude Developer Platform · in the page manage-claude/admin-api-keys …t accept Admin API keys (the service-account and federation endpoints noted at the top of this page do not accept Admin API keys). </Step> <Step title="Copy and store the secret"> Copy the di… analytics-api Claude Developer Platform · in the page manage-claude/analytics-api …ise, you can provision both keys and use each API for its own data. <Note> Looking for token usage and cost data rather than product analytics? See the [Usage and Cost Analytics API](https://platfo… api-and-data-retention Claude Developer Platform · in the page manage-claude/api-and-data-retention …claude/api-and-data-retention#retention-regardless-of-arrangement). <Note> For the most up-to-date information on which products and features are ZDR-eligible, refer to your contract terms or conta… app-attest Claude Developer Platform · in the page manage-claude/app-attest …it, so handle any per-user logic in your app. ## Set up App Attest <Note> App Attest requires a physical device. The Simulator, and hardware without a Secure Enclave, cannot perform App Attest. Wh… First request Claude Developer Platform · in the page manage-claude/claude-code-analytics-api …ection rates for different Claude Code tools (Edit, MultiEdit, Write, NotebookEdit) * **Cost analysis:** View estimated costs and token usage broken down by Claude model * **Custom reporting:** Export… claude-tag-api Claude Developer Platform · in the page manage-claude/claude-tag-api …se-organization) for where your primary owner creates one. </Check> <Note> The Claude Tag API is in **beta** and is available to Claude Enterprise organizations only. It is not available to Claude… cmek-coverage-claude-enterprise Claude Developer Platform · in the page manage-claude/cmek-coverage-claude-enterprise …ion-keys) (beta) plugin versions: each version’s description, release notes, components, and files. That page lists which requests still work while your key can’t be used. * Compliance API [local sess… Fetch the first page (newest activities first). Claude Developer Platform · in the page manage-claude/compliance-activity-feed …and paginate your organization's Compliance API Activity Feed. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… compliance-api Claude Developer Platform · in the page manage-claude/compliance-api …etrieve or delete content, and feed events into downstream tooling. <Note> Two key types unlock the Compliance API. A **Compliance Access Key** (created in claude.ai) reaches every endpoint, and an… compliance-api-access Claude Developer Platform · in the page manage-claude/compliance-api-access …coped permissions) or an Admin API key, and learn which to use. --- <Note> Claude Enterprise organizations and eligible standalone Claude Console organizations have self-service access to the Compl… WARNING: This operation PERMANENTLY deletes the chat, all of its messages, Claude Developer Platform · in the page manage-claude/compliance-content-data …rojects for claude.ai organizations through the Compliance API. --- <Note> The endpoints on this page are available only to Claude Enterprise organizations. They retrieve and delete claude.ai chats… compliance-errors Claude Developer Platform · in the page manage-claude/compliance-errors …responses by HTTP status code, with the cause and fix for each. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… compliance-faq Claude Developer Platform · in the page manage-claude/compliance-faq …bout Compliance API access, scopes, retention, and integration. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… before_id is the first_id from a previous response Claude Developer Platform · in the page manage-claude/compliance-integration-patterns …elate Compliance API events with your SIEM, and plan retention. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… compliance-org-data Claude Developer Platform · in the page manage-claude/compliance-org-data …h organization's effective settings through the Compliance API. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… check-events-against-results Claude Developer Platform · in the page manage-claude/compliance-security-posture/check-events-against-results …nt's current results and decide which mismatches need a person. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… detect-changes Claude Developer Platform · in the page manage-claude/compliance-security-posture/detect-changes …s, bursts of changes, and attestations that end automatically." --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… events-reference Claude Developer Platform · in the page manage-claude/compliance-security-posture/events-reference …values, an example of each, and what the feed does not record." --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… ocsf-mapping Claude Developer Platform · in the page manage-claude/compliance-security-posture/ocsf-mapping …hema Framework (OCSF) class and attributes before you store it. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… overview Claude Developer Platform · in the page manage-claude/compliance-security-posture/overview …posture page (Security Center) in claude.ai and where to start. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… results-reference Claude Developer Platform · in the page manage-claude/compliance-security-posture/results-reference …, the response fields, what each status means, and the errors." --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… send-events Claude Developer Platform · in the page manage-claude/compliance-security-posture/send-events …IEM current with a scheduled read that catches late activities. --- <Note> To enable the Compliance API, see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance… compliance-sessions Claude Developer Platform · in the page manage-claude/compliance-sessions …ode, and retrieve their transcripts through the Compliance API. --- <Note> The endpoints on this page are available only to Claude Enterprise organizations. The local and remote session endpoints a… data-residency Claude Developer Platform · in the page manage-claude/data-residency …eatureMetadata: status: stable zdr: eligibility: eligible note: Excludes [Covered Models](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-reten… inference-hooks Claude Developer Platform · in the page manage-claude/inference-hooks …server for an allow or deny verdict before inference proceeds. --- <Note> Inference hooks are available only to Claude Enterprise organizations. Configuring them requires the `organization:manage`… inference-hooks-configuration Claude Developer Platform · in the page manage-claude/inference-hooks-configuration …server, and control enforcement, failure handling, and rollout. --- <Note> Inference hooks are available only to Claude Enterprise organizations. Configuring them requires the `organization:manage`… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …ks requests, verifies them, and returns allow or deny verdicts. --- <Note> Inference hooks are available only to Claude Enterprise organizations. </Note> An Inference hooks integration is an AI se… ip-allowlist Claude Developer Platform · in the page manage-claude/ip-allowlist …) to stop using static keys. This is safer than allowlisting alone. <Note> IP allowlisting is available in beta under your agreement with Anthropic, such as the [Commercial Terms of Service](https:… opentelemetry Claude Developer Platform · in the page manage-claude/opentelemetry …Google Cloud (Google managed): beta Microsoft Foundry: beta --- <Note> OpenTelemetry export is in beta. It’s provided under your agreement with Anthropic, including the Beta Services section of… api Claude Developer Platform · in the page manage-claude/opentelemetry/api …ude/opentelemetry status: beta zdr: eligibility: eligible note: Excludes [Covered Models](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-reten… sdk Claude Developer Platform · in the page manage-claude/opentelemetry/sdk …s OpenTelemetry exporter sends them to your observability platform. <Note> During the beta, the SDK options and the span schema can change in ways that break your code, your queries, or your dashbo… organization-webhooks Claude Developer Platform · in the page manage-claude/organization-webhooks …ou manage it with the Admin API under `/v1/organizations/webhooks`. <Note> Event delivery isn’t live: Anthropic doesn’t send the two events, so an endpoint you register receives nothing. You can re… plugins-api Claude Developer Platform · in the page manage-claude/plugins-api …/en/api/versioning) header and the beta header shown in the following note. </Check> <Note> The Plugins API is in **beta** and is available to Claude Enterprise organizations only. It is not availa… rate-limits-api Claude Developer Platform · in the page manage-claude/rate-limits-api …ge that someone else made in between to the limiter types it names. <Note> Setting workspace rate limits is not available on [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-… spend-limits-api Claude Developer Platform · in the page manage-claude/spend-limits-api …ttps://platform.claude.com/docs/en/api/versioning) header. </Check> <Note> The Spend Limits API is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude… usage-cost-analytics-api Claude Developer Platform · in the page manage-claude/usage-cost-analytics-api …short-lived tokens and there’s no long-lived key to leak. </Check> <Note> **Claude Platform on AWS:** Both endpoints are available. Requests use the Claude Platform on AWS base URL and authenticat… First request Claude Developer Platform · in the page manage-claude/usage-cost-api …rm.claude.com/settings/organization`) in the Claude Console. </Tip> <Note> The Usage and Cost API (`/v1/organizations/usage_report/messages` and `/v1/organizations/cost_report`) is a legacy API and… user-management Claude Developer Platform · in the page manage-claude/user-management …e whether to remove the member. Requires the `write:members` scope. <Note> This endpoint is in **beta** for Claude Enterprise organizations. Every request must include the [beta header](https://… wif-admin-api Claude Developer Platform · in the page manage-claude/wif-admin-api …api/organization/federation/rules). ## Permissions and constraints <Note> * OAuth-authenticated callers can only create or modify rules whose `oauth_scope` is `workspace:developer` or `workspace:i…
Feedback