675 pages for detail.

streaming Claude Developer Platform · in the page build-with-claude/streaming …ws both sync and async streams. See the documentation in each SDK for details. <CodeGroup exclude="shell:cURL"> ```bash CLI ant messages create --stream \ --model claude-opus-5-5 \ --max-… structured-outputs Claude Developer Platform · in the page build-with-claude/structured-outputs …n, avoid logging it directly, or ensure that you redact any sensitive details from the error message. </Accordion> <Accordion title="Local schema validation"> Structured outputs support… thinking Claude Developer Platform · in the page build-with-claude/thinking …ude/thinking#controlling-thinking-display) for per-model defaults and details. If Claude uses tools, thinking can also appear between tool calls. See [Thinking with tool use](https://platform.claude.… thinking-steering-and-cost Claude Developer Platform · in the page build-with-claude/thinking-steering-and-cost …/docs/en/build-with-claude/thinking#interleaved-thinking)). For full details on how the thinking configuration and the effort parameter interact, see [Thinking and effort](https://platform.claude.com… token-counting Claude Developer Platform · in the page build-with-claude/token-counting …/build-with-claude/thinking#thinking-and-the-context-window) for more details. * Thinking blocks from **previous** assistant turns count toward your input tokens on models that [keep all prior turn… vision Claude Developer Platform · in the page build-with-claude/vision ….com/docs/en/api/messages/create) for more example code and parameter details. ### Multiple images You can include multiple images in a single request, and Claude analyzes them jointly. This is usef… working-with-messages Claude Developer Platform · in the page build-with-claude/working-with-messages …`` Refusal responses (`stop_reason: "refusal"`) also include a `stop_details` object identifying the policy category that triggered the refusal, on every model. See [What a refusal looks like](https:… API usage primer for Claude Claude Developer Platform · in the page claude_api_primer …9_-]{1,128}$`. | | `description` | A detailed plain text description of what the tool does, when it should be used, and how it behaves. | | `input_schema` | A [JSON Sc… apply Claude Developer Platform · in the page cli-sdks-libraries/cli/apply …1 created State written to ./claude-lock.json ``` Answer `d` to see details first: the fields of each new resource, or a field-by-field diff of each update. `--dry-run` prints that detailed plan and… sessions-connect Claude Developer Platform · in the page cli-sdks-libraries/cli/sessions-connect …| | Ctrl+O | Show or hide detail: tool inputs and results, token usage, and status events. `--verbose` (`-v`) starts with detail shown. | | Page Up, Page Do… openai-sdk Claude Developer Platform · in the page cli-sdks-libraries/libraries/openai-sdk …ude.com/docs/en/api/rate-limits) for the `/v1/messages` endpoint. ## Detailed OpenAI compatible API support ### Request fields #### Simple fields | Field | Support status… csharp Claude Developer Platform · in the page cli-sdks-libraries/sdks/csharp …t supported parts of the API. ## Platform integrations <Note> For detailed platform setup guides with code examples, see: * [Amazon Bedrock (`bedrock-mantle`)](https://platform.claude.com/docs/… go Claude Developer Platform · in the page cli-sdks-libraries/sdks/go …i-sdks-libraries/middleware). ## Platform integrations <Note> For detailed platform setup guides with code examples, see: * [Amazon Bedrock (`bedrock-mantle`)](https://platform.claude.com/docs/… java Claude Developer Platform · in the page cli-sdks-libraries/sdks/java …hemas: * `@JsonClassDescription` - Add a description to a tool class detailing when and how to use that tool. * `@JsonTypeName` - Set the tool name to something other than the simple name of the clas… php Claude Developer Platform · in the page cli-sdks-libraries/sdks/php …iddleware and the order in which several run. This section covers the details that are specific to the PHP SDK. A middleware is a callable that takes the request and `$next`, or an instance of a clas… For Amazon Bedrock support Claude Developer Platform · in the page cli-sdks-libraries/sdks/python …ovides support for tool use, also known as function calling. For more details, see [Tool use with Claude](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). ### Tool helpers Th… Automatically handles tool execution loop Claude Developer Platform · in the page cli-sdks-libraries/sdks/ruby …red data classes for tools and let Claude automatically run them. For detailed documentation on tool use patterns including the tool runner, see [Tool runner (SDK)](https://platform.claude.com/docs/en… typescript Claude Developer Platform · in the page cli-sdks-libraries/sdks/typescript …to the right tool and passing the result back to the model. For more details on tool use, see [Tool use with Claude](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). To run th… get-api-key Claude Developer Platform · in the page get-api-key …latform.claude.com/docs/en/manage-claude/authentication) for complete details, including short-lived credentials with Workload Identity Federation. ## API keys and the Admin API The [Admin API](http… get-started Claude Developer Platform · in the page get-started …reason": "end_turn", "stop_sequence": null, "stop_details": null, "usage": { "input_tokens": 21, "output_tokens": 305 } }… access-transparency Claude Developer Platform · in the page manage-claude/access-transparency …/api-and-data-retention#zero-data-retention-zdr-scope) for additional details. ## Getting started To enable Access Transparency: <Steps> <Step title="Request Access Transparency"> Contact you… access-transparency-log Claude Developer Platform · in the page manage-claude/access-transparency-log …de` * `actor`, with its nested `type` and `email_address` * `resource_details`, with its nested `type`, `id`, and `parent` Version `0x02` has the same 11 required fields and one optional field: * `u… admin-api Claude Developer Platform · in the page manage-claude/admin-api …n roles and permissions There are five organization-level roles. For details, see [API Console roles and permissions](https://support.claude.com/en/articles/10186004-api-console-roles-and-permissions… analytics-api Claude Developer Platform · in the page manage-claude/analytics-api …erprise Analytics API endpoints are not legacy. </Note> For endpoint details, parameters, and response schemas, see the [Claude Enterprise Analytics API reference](https://platform.claude.com/docs/en… api-and-data-retention Claude Developer Platform · in the page manage-claude/api-and-data-retention …n wording and does not change the resolution. Client-side tools whose Details column in the [feature eligibility table](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#feature… authentication Claude Developer Platform · in the page manage-claude/authentication …(https://platform.claude.com/docs/en/manage-claude/wif-reference) for details. ### Key expiration When you create an API key from the [API keys](https://platform.claude.com/settings/keys) page in th… First request Claude Developer Platform · in the page manage-claude/claude-code-analytics-api …oper productivity and build custom dashboards. This API provides more detail than the basic [Analytics dashboard](https://platform.claude.com/claude-code) in the Claude Console, without the complexity… claude-tag-api Claude Developer Platform · in the page manage-claude/claude-tag-api …rts with `slack_channel_set_up_` and the new channel’s `id` in `error.details.slack_channel_id` (see [Error responses](https://platform.claude.com/docs/en/manage-claude/claude-tag-api#error-responses)… cmek Claude Developer Platform · in the page manage-claude/cmek …s/en/manage-claude/access-transparency#cmek-content-preservation) for details. Safety screening metadata (records derived from Anthropic's automated safety scans, such as pattern identifiers and match… cmek-azure-key-vault Claude Developer Platform · in the page manage-claude/cmek-azure-key-vault …d click **Continue**. </Step> <Step title="Enter the key details"> Check that your key has the **Organization tag** shown in the dialog box. Enter the **Vault URI**, **Key name**,… cmek-claude-platform-on-aws Claude Developer Platform · in the page manage-claude/cmek-claude-platform-on-aws …orm.claude.com/docs/en/api/claude-platform-on-aws-iam-actions#service-details) instead, in this form: ```text wrap arn:aws:aws-external-anthropic:<REGION>:<AWS_ACCOUNT_ID>:workspace/<WORKSPACE_ID> ``… cmek-coverage-claude-enterprise Claude Developer Platform · in the page manage-claude/cmek-coverage-claude-enterprise …*Settings**. | Data | Details… cmek-coverage-claude-platform Claude Developer Platform · in the page manage-claude/cmek-coverage-claude-platform …| Details… cmek-data-retention Claude Developer Platform · in the page manage-claude/cmek-data-retention …s/en/manage-claude/access-transparency#cmek-content-preservation) for details. Safety screening metadata is retained under Anthropic-managed encryption and remains readable after key revocation. These… cmek-google-cloud-kms Claude Developer Platform · in the page manage-claude/cmek-google-cloud-kms …<Step title="Open the key’s permissions"> On the key ring details page, select the checkbox next to the key. Open the **Permissions** panel and click **Grant access**. </Step>… cmek-troubleshooting Claude Developer Platform · in the page manage-claude/cmek-troubleshooting …etry, click **Add key** again. The dialog box opens with your earlier details. Select the checkbox, click **Continue**, then click **Add**. ## Expected errors in CloudTrail On Claude Platform and Cl… WARNING: This operation PERMANENTLY deletes the chat, all of its messages, Claude Developer Platform · in the page manage-claude/compliance-content-data …text documents. The Compliance API exposes project metadata, project details, and the list of attachments belonging to a project. * [List projects](https://platform.claude.com/docs/en/api/compliance… compliance-errors Claude Developer Platform · in the page manage-claude/compliance-errors …hare a status code and type are told apart by an error code in `error.details.error_code` when the response carries one, and otherwise by their message; each is called out where it applies. The follo… results-reference Claude Developer Platform · in the page manage-claude/compliance-security-posture/results-reference …rrors#429-too-many-requests). | | 503 `overloaded_error`, with `error.details.error_code` of `posture_evaluation_failed` | The result could not be produced.… compliance-sessions Claude Developer Platform · in the page manage-claude/compliance-sessions …e session, the messages endpoint might also return a 429 whose `error.details.error_code` is `transcript_read_server_busy`. It does not mean that your organization exceeded a rate limit. Unlike the 40… data-residency Claude Developer Platform · in the page manage-claude/data-residency …m.claude.com/docs/en/about-claude/pricing#data-residency-pricing) for details. The same multiplier applies to [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/overview): whe… inference-hooks Claude Developer Platform · in the page manage-claude/inference-hooks …request and response schemas, signature verification, and operational details, see [Develop an Inference hooks integration](https://platform.claude.com/docs/en/manage-claude/inference-hooks-endpoint).… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …if any value matches yours, using a constant-time comparison. | Two details cause most verification bugs: * **Verify raw bytes.** Compute the HMAC over the body exactly as received, before any JSON… api Claude Developer Platform · in the page manage-claude/opentelemetry/api …n’t listed. If you select a listed platform, the Console asks for its details, such as an API key, instead of the **OTLP endpoint URL**, **Request headers**, and **OTLP traces endpoint URL**.… plugins-api Claude Developer Platform · in the page manage-claude/plugins-api …platform.claude.com/docs/en/manage-claude/plugins-api#scopes) has the details, including two other read scopes that also work. See [Create an Admin API key](https://platform.claude.com/docs/en/manage-… rate-limits-api Claude Developer Platform · in the page manage-claude/rate-limits-api …atform.claude.com/docs/en/manage-claude/admin-api#authentication) for details. </Check> The SDK’s default client and the CLI read the Admin API key from the `ANTHROPIC_API_KEY` environment variable.… spend-limits-api Claude Developer Platform · in the page manage-claude/spend-limits-api …end`. Requires the `read:spend_limits` scope. For complete parameter details and response schemas, see [List effective spend limits](https://platform.claude.com/docs/en/api/beta/organization/spend_li… First request Claude Developer Platform · in the page manage-claude/usage-cost-api …atform.claude.com/docs/en/manage-claude/admin-api#authentication) for details. </Check> Claude Enterprise organizations use an Analytics API key with a different API instead; see [Which API do you ne… user-management Claude Developer Platform · in the page manage-claude/user-management …ple.com`). Requires the `read:members` scope. For complete parameter details and response schemas, see [List users](https://platform.claude.com/docs/en/api/organization/users/list) in the API referen… user-profiles Claude Developer Platform · in the page manage-claude/user-profiles …pic sets. It doesn’t contain conversation content. Anthropic uses the details you send to attribute requests, to monitor for abuse, for enforcement of the [Usage Policy](https://www.anthropic.com/lega…