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

404 pages for setup.

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

typescript Claude Developer Platform · in the page cli-sdks-libraries/sdks/typescript …/Accordion> ## Platform integrations <Note> For detailed platform setup guides with code examples, see: * [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon… home Claude Developer Platform · in the page home …brain" href="https://platform.claude.com/docs/en/managed-agents/agent-setup"> Define your agent </HomeCardLink> </HomePlatformCard> </HomePlatformCards> <HomePartnerLi… authentication Claude Developer Platform · in the page manage-claude/authentication ….com/docs/en/manage-claude/workload-identity-federation) for the full setup walkthrough. ## App Attest App Attest authenticates iOS and macOS apps that call the Claude API directly from the device.… cmek-aws-kms Claude Developer Platform · in the page manage-claude/cmek-aws-kms …email, chat, or any onboarding channel. </Warning> ## Encryption key setup ### Prepare the key policy Copy this policy into a text editor: ```json key-policy.json { "Version": "2012-10-17", "S… cmek-azure-key-vault Claude Developer Platform · in the page manage-claude/cmek-azure-key-vault …email, chat, or any onboarding channel. </Warning> ## Encryption key setup The key must meet these requirements: * **Type:** RSA, 3072-bit or larger. For an HSM-backed key, use `RSA-HSM`, which req… cmek-claude-platform-on-aws Claude Developer Platform · in the page manage-claude/cmek-claude-platform-on-aws …email, chat, or any onboarding channel. </Warning> ## Encryption key setup ### Prepare the key policy Copy this policy into a text editor: ```json key-policy.json { "Version": "2012-10-17", "S… cmek-google-cloud-kms Claude Developer Platform · in the page manage-claude/cmek-google-cloud-kms …st. Contact Anthropic for the customer ID. </Note> ## Encryption key setup The key must meet these requirements: * **Location:** Use a single-region US location, such as `us-east5`. Multi-region lo… compliance-api-access Claude Developer Platform · in the page manage-claude/compliance-api-access …s**, not in Claude Console. </Warning> ## Set up the Compliance API Setup is one flow: enable the Compliance API for your organization, then create a Compliance Access Key in claude.ai. A Claude Con… compliance-sessions Claude Developer Platform · in the page manage-claude/compliance-sessions …| | Setup | Works with your existing Compliance Access Key… data-residency Claude Developer Platform · in the page manage-claude/data-residency …nfiguration](https://platform.claude.com/docs/en/managed-agents/agent-setup#pin-the-inference-geo) pins the geography that serves model requests for sessions running that agent, with [per-session over… inference-hooks-endpoint Claude Developer Platform · in the page manage-claude/inference-hooks-endpoint …Anthropic sends is signed, including the connection test, because the setup flow generates the secret before the first test. [Enabling Inference hooks requires a secret](https://platform.claude.com/do… opentelemetry Claude Developer Platform · in the page manage-claude/opentelemetry …ms that support the conventions can recognize the spans without extra setup. ## Get started You can set up SDK tracing, API tracing, or both. Set up both to see a request's SDK and API spans in one… sdk Claude Developer Platform · in the page manage-claude/opentelemetry/sdk …an OTLP exporter that points to your observability platform. For the setup in your language, see the OpenTelemetry docs on [Python exporters](https://opentelemetry.io/docs/languages/python/exporters/… wif-admin-api Claude Developer Platform · in the page manage-claude/wif-admin-api …for itself. The next section walks through this once-per-organization setup. ## Bootstrap a workload to manage WIF One Console-created rule is enough to put the rest of your federation configuration… aws Claude Developer Platform · in the page manage-claude/wif-providers/aws …ent.find { it.type == :text }.text ``` </CodeGroup> ### Verify the setup From inside the workload, exchange an STS-issued token directly and inspect the response: ```bash cURL JWT=$(aws sts get-w… Create the app registration that represents the Claude API audience. Claude Developer Platform · in the page manage-claude/wif-providers/azure …ID, then exchanging it for a short-lived Anthropic access token. The setup follows the same shape on every Azure platform: 1. **Register the token audience:** Create one app registration in your Mic… gcp Claude Developer Platform · in the page manage-claude/wif-providers/gcp …pires_in`, refresh on a timer and repeat the exchange. ## Verify the setup From inside your workload, decode the identity token and confirm the claims match your rule: ```bash cURL curl -sS -H "Met… github-actions Claude Developer Platform · in the page manage-claude/wif-providers/github-actions …_REQUEST_URL` directly instead of using the file path. ## Verify the setup A successful exchange returns an `access_token` beginning with `sk-ant-oat01-` and an `expires_in` value in seconds. A deni… kubernetes Claude Developer Platform · in the page manage-claude/wif-providers/kubernetes …tent.find { it.type == :text }.text ``` </CodeGroup> ## Verify the setup A successful exchange returns an `access_token` beginning with `sk-ant-oat01-` and an `expires_in` value in seconds. If the… okta Claude Developer Platform · in the page manage-claude/wif-providers/okta …**Client ID**. 2. **Configure client authentication.** For a keyless setup, select **Public key / Private key** (`private_key_jwt`) and register your workload's public JWK. Alternatively, use a clien… Replace NODE_UID with the node's UID: Claude Developer Platform · in the page manage-claude/wif-providers/spiffe …as in the file-based tab. </Note> </Tab> </Tabs> ## Verify the setup Before integrating the SDK, fetch a JWT-SVID directly from SPIRE Agent and confirm the claims match what your federation ru… wif-reference Claude Developer Platform · in the page manage-claude/wif-reference …m.claude.com/docs/en/manage-claude/workload-identity-federation). For setup walkthroughs, see the [provider guides](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation#ident… workload-identity-federation Claude Developer Platform · in the page manage-claude/workload-identity-federation …-identity-federation#authenticate-from-your-workload)) to confirm the setup works. If the window elapses, the resources persist; you can re-run the test from the federation rule's detail page. Note th… choosing-an-environment Claude Developer Platform · in the page managed-agents/choosing-an-environment …the [agent](https://platform.claude.com/docs/en/managed-agents/agent-setup), not on the environment. ## Start with a cloud environment If you're not sure which to choose, or you're new to Claude Ma… DCF Model Rubric Claude Developer Platform · in the page managed-agents/define-outcomes …ting [agent](https://platform.claude.com/docs/en/managed-agents/agent-setup) and [environment](https://platform.claude.com/docs/en/managed-agents/environments) (both created separately), then send a `… environments Claude Developer Platform · in the page managed-agents/environments --- title: Cloud environment setup url: https://platform.claude.com/docs/en/managed-agents/environments description: Customize cloud sandboxes for your sessions. featureMetadata: topic: title: M… memory Claude Developer Platform · in the page managed-agents/memory …nt creation](https://platform.claude.com/docs/en/managed-agents/agent-setup). On [self-hosted sandboxes](https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes-memory), that director… migration Claude Developer Platform · in the page managed-agents/migration …`) once; the Agent is persisted and versioned server-side. See [Agent setup](https://platform.claude.com/docs/en/managed-agents/agent-setup). | | `async with ClaudeSDKClient(...)` or `query(...)`… multiagent-orchestration Claude Developer Platform · in the page managed-agents/multiagent-orchestration …ality and can also improve time to completion. Not sure a multiagent setup fits your problem? See [when to use multiagent systems (and when not to)](https://claude.com/blog/building-multi-agent-syste… permission-policies Claude Developer Platform · in the page managed-agents/permission-policies …g the agent](https://platform.claude.com/docs/en/managed-agents/agent-setup#update-an-agent). Running sessions keep the toolset configuration they were created with. Updates apply to sessions created… quickstart Claude Developer Platform · in the page managed-agents/quickstart …de](https://claude.com/product/claude-code) can guide you through the setup and answer your questions: Let Claude Code set up your agent for you ```text /claude-api managed-agents-onboard ``… scheduled-deployments Claude Developer Platform · in the page managed-agents/scheduled-deployments …s an [agent](https://platform.claude.com/docs/en/managed-agents/agent-setup) to start [sessions](https://platform.claude.com/docs/en/managed-agents/sessions) autonomously, so the agent can complete ta… secure-deployment Claude Developer Platform · in the page managed-agents/secure-deployment …its-and-a-way-to-stop). </Note> See [Networking in Cloud environment setup](https://platform.claude.com/docs/en/managed-agents/environments#networking) for every networking setting. ## Keep credenti… secure-deployment-monitoring Claude Developer Platform · in the page managed-agents/secure-deployment-monitoring …lags behavior beyond what the agent was granted. For a review prompt, setup steps, and working code, see the [security review recipe](https://platform.claude.com/cookbook/managed-agents-cma-agent-secu… spawn.sh: called once per claimed work item Claude Developer Platform · in the page managed-agents/self-hosted-sandboxes …the [agent](https://platform.claude.com/docs/en/managed-agents/agent-setup), not the environment. </Note> ## How it differs from cloud environments | | Cloud environme… self-hosted-sandboxes-reference Claude Developer Platform · in the page managed-agents/self-hosted-sandboxes-reference …| Handles polling, setup, and execution end to end. | Most cases.… self-hosted-sandboxes-workers Claude Developer Platform · in the page managed-agents/self-hosted-sandboxes-workers …ueue continuously and needs only outbound HTTPS. This is the simplest setup. * **Webhook-triggered:** A handler wakes on `session.status_run_started` and starts polling. This avoids an idle poller, bu… sessions Claude Developer Platform · in the page managed-agents/sessions …s an [agent](https://platform.claude.com/docs/en/managed-agents/agent-setup) and an [environment](https://platform.claude.com/docs/en/managed-agents/environments) (both created separately), and mainta… skills Claude Developer Platform · in the page managed-agents/skills …## Next steps <CardGroup cols={2}> <Card title="Cloud environment setup" icon="settings" href="https://platform.claude.com/docs/en/managed-agents/environments"> Customize cloud sandboxes for y… tools-web-restrictions Claude Developer Platform · in the page managed-agents/tools-web-restrictions …te an agent](https://platform.claude.com/docs/en/managed-agents/agent-setup#create-an-agent) or [update an agent](https://platform.claude.com/docs/en/managed-agents/agent-setup#update-an-agent). It al… webhooks Claude Developer Platform · in the page managed-agents/webhooks …f the agent](https://platform.claude.com/docs/en/managed-agents/agent-setup#update-an-agent) was published. Updates that do not create a new version do not trigger this event. | | `agent.archived`… overview Claude Developer Platform · in the page release-notes/overview …e the agent](https://platform.claude.com/docs/en/managed-agents/agent-setup#pin-the-inference-geo), or [override it for a single session](https://platform.claude.com/docs/en/managed-agents/sessions#pi… increase-consistency Claude Developer Platform · in the page test-and-evaluate/strengthen-guardrails/increase-consistency …you were in the office. Let me know if you run into any issues during setup.</answer> </response> ``` </Accordion> ## Chain prompts for complex tasks Break down complex tasks into smaller, consi… How the agent loop works Claude Code CLI · in the page agent-sdk/agent-loop …* `"init"`: session metadata for the run. When a `SessionStart` or `Setup` hook runs during session startup, its [hook lifecycle messages](/docs/en/agent-sdk/typescript.md#sdkhookstartedmessage) arr… Use Claude Code features in the SDK Claude Code CLI · in the page agent-sdk/claude-code-features …Not loaded when `CLAUDE_CODE_OAUTH_TOKEN` holds a token from [`claude setup-token`](/docs/en/authentication#generate-a-long-lived-token), which can only make model requests. Passing `mcpServers: {}` d… Examples Claude Code CLI · in the page agent-sdk/examples …art.md): build your first working agent in TypeScript or Python, with setup steps included. The agent finds and fixes bugs in a sample file. * [Hello World](https://github.com/anthropics/claude-agent… Rewind file changes with checkpointing Claude Code CLI · in the page agent-sdk/file-checkpointing …laude` executable, which comes from [installing Claude Code](/docs/en/setup.md). The SDK enables checkpointing for you, but when you run `claude -p` directly you must set the `CLAUDE_CODE_ENABLE_SDK_F… Intercept and control agent behavior with hooks Claude Code CLI · in the page agent-sdk/hooks …tatus messages | Send agent status updates to Slack or PagerDuty | | `Setup` | No | Yes | Session setup/maintenance | Run initialization tasks | | `TeammateIdle` | No | Yes | Teammate becomes idle | R… Hosting the Agent SDK Claude Code CLI · in the page agent-sdk/hosting …ecure-deployment.md#credential-management) for the proxy pattern and [Setup in the SDK quickstart](/docs/en/agent-sdk/quickstart.md#setup) for supported authentication methods. * **Inbound**: put auth… Agent SDK reference - Python Claude Code CLI · in the page agent-sdk/python …install claude-agent-sdk ``` For uv, Windows PowerShell, and API key setup, see [Setup in the Agent SDK quickstart](/docs/en/agent-sdk/quickstart.md#setup). ## Choosing between `query()` and `Claude…
Feedback