API referenceSupport & configuration
Versions
When making API requests, you must send an anthropic-version request header. For example, anthropic-version: 2026-10-21. If you are using the client SDKs, this is handled for you automatically.
For any given API version, Anthropic preserves:
- Existing input parameters
- Existing output parameters
However, Anthropic may do the following:
- Add additional optional inputs
- Add additional values to the output
- Change conditions for specific error types
- Add new variants to enum-like output values (for example, streaming event types)
Generally, if you are using the API as documented in this reference, Anthropic will not break your usage.
Version history
Anthropic recommends using the latest API version whenever possible.
2026-10-21- Migrating to API version 2026-10-21 shows how to upgrade.
- Available on the Claude API, Claude Platform on AWS, Claude Models on Google Cloud (Anthropic managed), Microsoft Foundry, and Claude Models on Google Cloud (Google managed). On Amazon Bedrock, it’s available for Claude 4.7 and later models. For other models on Bedrock, see the migration guide for API version 2026-10-21.
- Messages API:
- A request that places a
documentblock directly in anassistantmessage returns a 400 error. - Sending a
textblock with a non-emptycitationsarray in ausermessage, directly or inside asearch_resultblock, returns a 400 error. - The
temperature,top_p, andtop_krequest parameters are removed. A request that sends any of them returns a 400 error on every model.
- A request that places a
- Admin API:
- RBAC groupsPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. no longer return
roles. Userole_idsinstead. - RBAC group membersPreview with links to the API reference available — press Tab until focus enters the card, Escape to return., and the response to removing one, no longer return
group_id. Userbac_group_idinstead. - RBAC rolesPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. no longer return
name. Usedisplay_nameinstead. - OrganizationPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. and workspacePreview with links to the API reference available — press Tab until focus enters the card, Escape to return. rate-limit entries, and the response to setting a workspace’s rate limitsPreview with links to the API reference available — press Tab until focus enters the card, Escape to return., no longer return
group_type. Usegroup.typeinstead. - API keysPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. no longer return
workspace_id. Usescope.workspace_idinstead, which gives the workspace’s real ID even for the Default Workspace (an all-workspaces key has noworkspace_idinscope).
- RBAC groupsPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. no longer return
- Claude Enterprise Analytics API:
- The per-user usagePreview with links to the API reference available — press Tab until focus enters the card, Escape to return. and costPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. reports no longer have
actor.email. Useactor.email_addressinstead. - The activity summariesPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. response no longer has
summaries. Usedatainstead.
- The per-user usagePreview with links to the API reference available — press Tab until focus enters the card, Escape to return. and costPreview with links to the API reference available — press Tab until focus enters the card, Escape to return. reports no longer have
2023-06-01- New format for streaming server-sent events (SSE):
- Completions are incremental. For example,
" Hello"," my"," name"," is"," Claude."instead of" Hello"," Hello my"," Hello my name"," Hello my name is"," Hello my name is Claude.". - All events are named events, rather than data-only events.
- Removed unnecessary
data: [DONE]event.
- Completions are incremental. For example,
- Removed legacy
exceptionandtruncatedvalues in responses.
- New format for streaming server-sent events (SSE):
2023-01-01: Initial release.
Was this page helpful?