Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,296 pages for type.

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

working-with-messages Claude Developer Platform · in the page build-with-claude/working-with-messages …C_API_KEY" \ -H "anthropic-version: 2023-06-01" \ -H "content-type: application/json" \ -d '{ "model": "claude-opus-5-5", "max_tokens": 1024, "messages": [ {"role… API usage primer for Claude Claude Developer Platform · in the page claude_api_primer …API ### Basic request and response <CodeGroup exclude="shell:cURL, typescript, csharp, go, java, php, ruby"> ```bash CLI ant messages create \ --model claude-opus-5-5 \ --max-tokens 102… apply Claude Developer Platform · in the page cli-sdks-libraries/cli/apply …name: Summarizer model: claude-opus-5-5 tools: - type: agent_toolset_20260401 --- You are a helpful assistant that writes concise summaries. ``` </File> <… On a remote host without a browser: Claude Developer Platform · in the page cli-sdks-libraries/cli/authentication …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace, you must [specify the workspace](https://platform.claude.com/docs/en/manage-claude/authen… quickstart Claude Developer Platform · in the page cli-sdks-libraries/cli/quickstart …ource src="https://platform.claude.com/docs/videos/ant-cli-demo.webm" type="video/webm" /> <source src="https://platform.claude.com/docs/videos/ant-cli-demo.mp4" type="video/mp4" /> </video> </F… scripting Claude Developer Platform · in the page cli-sdks-libraries/cli/scripting …--session-id session_01JZCh78XvmxJjiXVy3oSi7K \ --event '{type: user.message, content: [{type: text, text: "Summarize the benefits of type safety in one sentence."}]}' ``` </Step>… sessions-connect Claude Developer Platform · in the page cli-sdks-libraries/cli/sessions-connect …policies#respond-to-confirmation-requests) event, with any reason you type as its `deny_message`. If the session is `terminated` or deleted, the view is read-only. ## Open the session viewer in your… using Claude Developer Platform · in the page cli-sdks-libraries/cli/using …eve --model-id claude-opus-5-5 --format yaml ``` ```text Output wrap type: model id: claude-opus-5-5 display_name: Claude Opus 5.5 created_at: "2026-09-22T00:00:00Z" ... ``` List endpoints auto-pagi… apple-foundation-models Claude Developer Platform · in the page cli-sdks-libraries/libraries/apple-foundation-models …is the Foundation Models provider conformance plus the configuration types that reach it (`ClaudeLanguageModel`, `ClaudeModel`, `AuthMode`, `ClaudeServerTool`). For direct access to the Messages API… openai-sdk Claude Developer Platform · in the page cli-sdks-libraries/libraries/openai-sdk …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace, also send the `anthropic-workspace-id` header on every request (for example, `default_hea… middleware Claude Developer Platform · in the page cli-sdks-libraries/middleware …the outgoing request and the next handler. Call `call_next(request)` (typescript: `next(request)`; csharp: `next(request, cancellationToken)`; go: `next(req)`; java: `nextClient.execute(request, reque… overview Claude Developer Platform · in the page cli-sdks-libraries/overview …. * **Client SDKs:** General-purpose Messages API clients for Python, TypeScript, C#, Go, Java, PHP, and Ruby. Each SDK provides idiomatic interfaces, type safety, and built-in support for streaming,… csharp Claude Developer Platform · in the page cli-sdks-libraries/sdks/csharp …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace, set the workspace ID in the `anthropic-workspace-id` request header; [Select a workspace]… go Claude Developer Platform · in the page cli-sdks-libraries/sdks/go …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace, set the workspace ID in the `anthropic-workspace-id` request header; [Select a workspace]… java Claude Developer Platform · in the page cli-sdks-libraries/sdks/java …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace, set the workspace ID in the `anthropic-workspace-id` request header; [Select a workspace]… php Claude Developer Platform · in the page cli-sdks-libraries/sdks/php …k = array_find($message->content, static fn ($block): bool => $block->type === 'text'); echo $textBlock->text; ``` For authentication options including Workload Identity Federation, see [Authenticati… For Amazon Bedrock support Claude Developer Platform · in the page cli-sdks-libraries/sdks/python …odel="claude-opus-5-5", ) for block in message.content: if block.type == "text": print(block.text) ``` <Tip> Consider using [python-dotenv](https://pypi.org/project/python-dotenv/) to… Automatically handles tool execution loop Claude Developer Platform · in the page cli-sdks-libraries/sdks/ruby …description: Install and configure the Anthropic Ruby SDK with Sorbet types, streaming helpers, and connection pooling --- The Anthropic Ruby library provides convenient access to the Claude API from… get-api-key Claude Developer Platform · in the page get-api-key …`platform.claude.com/settings/keys`) in the Console. ## Choose a key type When you create a key, you choose its type, which determines what the key can do, where it works, and when it stops working.… get-started Claude Developer Platform · in the page get-started …curl https://api.anthropic.com/v1/messages \ -H "content-type: application/json" \ -H "x-api-key: $ANTHROPIC_API_KEY" \ -H "anthropic-version: 2023-06-01" \… home Claude Developer Platform · in the page home …} ], ) for block in message.content: if block.type == "text": print(block.text) ``` ```typescript TypeScript import Anthropic from "@anthropic-ai/sdk";… access-transparency Claude Developer Platform · in the page manage-claude/access-transparency …form.claude.com/docs/en/manage-claude/compliance-activity-feed) event types. * **Claude for Enterprise and Claude Apps:** claude.ai Enterprise seats, Claude for Work, Cowork, and Claude in Chrome are… access-transparency-log Claude Developer Platform · in the page manage-claude/access-transparency-log …anage-claude/compliance-errors) for the envelope and the shared error types. | Status | Meaning on this surface… admin-api Claude Developer Platform · in the page manage-claude/admin-api …der. The key has the same permissions as the linked account. See [Key types](https://platform.claude.com/docs/en/manage-claude/authentication#key-types). An Admin API key covers most endpoints. The s… analytics-api Claude Developer Platform · in the page manage-claude/analytics-api …alytics API key created in claude.ai. The two APIs use different key types, created in different places by different roles. This page describes which API fits your organization and how to create the… api-and-data-retention Claude Developer Platform · in the page manage-claude/api-and-data-retention …ent accidental use of features not covered by your BAA: ```text { "type": "error", "error": { "type": "invalid_request_error", "message": "The requested features are not available for HIP… authentication Claude Developer Platform · in the page manage-claude/authentication …ery request as a bearer token in the `Authorization` header. ### Key types When you create a key, you choose its type, which determines what the key can do, where it works, and when it stops working… First request Claude Developer Platform · in the page manage-claude/claude-code-analytics-api …de.com/docs/en/manage-claude/analytics-api) to find which API and key type your organization needs. </Note> ## Quick start Get your organization's Claude Code analytics for a specific day: ```bash… cmek-aws-kms Claude Developer Platform · in the page manage-claude/cmek-aws-kms …> Make sure that these options are selected: * **Key type:** Symmetric * **Key usage:** Encrypt and decrypt * **Advanced options > Key material origin:** KMS *… cmek-azure-key-vault Claude Developer Platform · in the page manage-claude/cmek-azure-key-vault …## Encryption key setup The key must meet these requirements: * **Type:** RSA, 3072-bit or larger. For an HSM-backed key, use `RSA-HSM`, which requires a Premium-SKU vault. * **Permitted operation… cmek-claude-platform-on-aws Claude Developer Platform · in the page manage-claude/cmek-claude-platform-on-aws …> Make sure that these options are selected: * **Key type:** Symmetric * **Key usage:** Encrypt and decrypt * **Advanced options > Key material origin:** KMS *… cmek-google-cloud-kms Claude Developer Platform · in the page manage-claude/cmek-google-cloud-kms ….claude.com/docs/en/manage-claude/cmek#availability-and-regions). * **Type:** Use a symmetric key with the `ENCRYPT_DECRYPT` purpose. Anthropic strongly recommends HSM protection. * **Organization lab… Fetch the first page (newest activities first). Claude Developer Platform · in the page manage-claude/compliance-activity-feed …claude/compliance-api-access) for the conditions under which each key type carries the scope. </Check> The Activity Feed records authentication, chat, file, project, administrative, and platform acti… compliance-api Claude Developer Platform · in the page manage-claude/compliance-api …e 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 **Admin API key… compliance-api-access Claude Developer Platform · in the page manage-claude/compliance-api-access …nization owner (claude.ai). </Check> The Compliance API uses two key types, and which one you create depends on which Claude product your organization uses. Primary owners and organization owners cre… WARNING: This operation PERMANENTLY deletes the chat, all of its messages, Claude Developer Platform · in the page manage-claude/compliance-content-data …_at": "2026-04-10T08:09:10Z", "content": [ { "type": "text", "text": "Can you help me draft requirements for our new dashboard feature?" } ], "fil… compliance-errors Claude Developer Platform · in the page manage-claude/compliance-errors …` response header, and a JSON body with an `error` object containing `type` and `message`. Include the `request-id` header value when you escalate to support. ```text { "error": { "type": "perm… compliance-faq Claude Developer Platform · in the page manage-claude/compliance-faq …he parent. To call the Compliance API, you create one of two key types instead: * **For full Compliance API access ([Activity Feed](https://platform.claude.com/docs/en/manage-claude/complian… before_id is the first_id from a previous response Claude Developer Platform · in the page manage-claude/compliance-integration-patterns …| `actor.user_id` and `actor.email_address` are present when `actor.type` is `user_actor`. `actor.ip_address` and `actor.user_agent` are absent on some actor types, such as `anthropic_actor` and `sc… compliance-org-data Claude Developer Platform · in the page manage-claude/compliance-org-data …ccess Keys (`sk-ant-api01-...`) created in claude.ai are the only key type accepted; see [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access) to provisi… compliance-sessions Claude Developer Platform · in the page manage-claude/compliance-sessions …setting | | Host and device metadata (terminal type, workspace paths) | No… data-residency Claude Developer Platform · in the page manage-claude/data-residency …C_API_KEY" \ -H "anthropic-version: 2023-06-01" \ -H "content-type: application/json" \ -d '{ "model": "claude-opus-5-5", "max_tokens": 1024, "inference_geo": "us",… inference-hooks Claude Developer Platform · in the page manage-claude/inference-hooks …com/en/articles/16893491-get-started-with-smart-reports). What a user types or uploads when creating a report is governed. *** ## Inference hooks versus the Compliance API Both features serve secur… inference-hooks-configuration Claude Developer Platform · in the page manage-claude/inference-hooks-configuration …Recent errors:** each entry shows when the failure occurred, an error type, and a category. The category is `webhook_error` for a problem with your endpoint or the connection to it, or `relay_error` f… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …self.send_response(200) self.send_header("Content-Type", "application/json") self.send_header("Content-Length", str(len(verdict))) self.end_headers()… opentelemetry Claude Developer Platform · in the page manage-claude/opentelemetry …from the end of the result. Images and documents appear only as their type. Change the limit in these cases: * **Your observability platform accepts larger payloads:** Raise or remove the limit to k… api Claude Developer Platform · in the page manage-claude/opentelemetry/api …"anthropic-beta: telemetry-destinations-2026-08-11" \ -H "content-type: application/json" \ -d '{ "endpoint_url": "https://gateway.example.com/otlp", "headers": {"authorization": "… sdk Claude Developer Platform · in the page manage-claude/opentelemetry/sdk …ash pip install opentelemetry-sdk ``` </Tab> <Tab title="TypeScript"> ```bash npm install @anthropic-ai/sdk@latest ``` If your application doesn't use the OpenTelemetry S… organization-webhooks Claude Developer Platform · in the page manage-claude/organization-webhooks …(https://platform.claude.com/docs/en/manage-claude/authentication#key-types) that isn't scoped to a workspace. ## Event types Organization webhook endpoints accept two event types. Both are about [e… plugins-api Claude Developer Platform · in the page manage-claude/plugins-api …2023-06-01`, and `anthropic-beta: ce-plugins-2026-09-01`. In Python, TypeScript, C#, Go, Java, PHP, and Ruby, the SDK exposes these endpoints under `client.beta.organization` (csharp, go: `client.Bet…
Feedback