中文 ← MyDocs

OpenAI SDK compatibility

Anthropic provides a compatibility layer that enables you to use the OpenAI SDK to test the Claude API. With a few code changes, you can quickly evaluate Anthropic model capabilities.


Note

This compatibility layer is primarily intended to test and compare model capabilities, and is not considered a long-term or production-ready solution for most use cases. While it is intended to remain fully functional and not have breaking changes, the priority is the reliability and effectiveness of the Claude API.

For more information on known compatibility limitations, see Important OpenAI compatibility limitations.

If you encounter any issues with the OpenAI SDK compatibility feature, please share your feedback via this compatibility feedback form.

Tip

For the best experience and access to Claude API full feature set (PDF processing, citations, extended thinking, and prompt caching), use the native Claude API.

Getting started with the OpenAI SDK

To use the OpenAI SDK compatibility feature, you'll need to:

  1. Use an official OpenAI SDK
  2. Change the following
    • Update your base URL to point to the Claude API
    • Replace your API key with a Claude API key
    • Update your model name to use a Claude model
  3. Review the documentation below for what features are supported

Quick start example

import os

from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("ANTHROPIC_API_KEY"),  # Your Claude API key
    base_url="https://api.anthropic.com/v1/",  # the Claude API endpoint
)

response = client.chat.completions.create(
    model="claude-opus-4-7",  # Claude model name
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who are you?"},
    ],
)

print(response.choices[0].message.content)
import OpenAI from "openai";

const openai = new OpenAI({
  apiKey: "ANTHROPIC_API_KEY", // Your Claude API key
  baseURL: "https://api.anthropic.com/v1/" // Claude API endpoint
});

const response = await openai.chat.completions.create({
  messages: [{ role: "user", content: "Who are you?" }],
  model: "claude-opus-4-7" // Claude model name
});

console.log(response.choices[0].message.content);

Important OpenAI compatibility limitations

API behavior

Here are the most substantial differences from using OpenAI:

  • The strict parameter for function calling is ignored, which means the tool use JSON is not guaranteed to follow the supplied schema. For guaranteed schema conformance, use the native Claude API with Structured Outputs.
  • Audio input is not supported; it will simply be ignored and stripped from input
  • Prompt caching is not supported, but it is supported in the Anthropic SDK
  • System/developer messages are hoisted and concatenated to the beginning of the conversation, as Anthropic only supports a single initial system message.

Most unsupported fields are silently ignored rather than producing errors. These are all documented below.

Output quality considerations

If you’ve done lots of tweaking to your prompt, it’s likely to be well-tuned to OpenAI specifically. Consider using the prompt improver in the Claude Console as a good starting point.

System / developer message hoisting

Most of the inputs to the OpenAI SDK clearly map directly to Anthropic’s API parameters, but one distinct difference is the handling of system / developer prompts. These two prompts can be put throughout a chat conversation via OpenAI. Since Anthropic only supports an initial system message, the API takes all system/developer messages and concatenates them together with a single newline (\n) in between them. This full string is then supplied as a single system message at the start of the messages.

Extended thinking support

You can enable extended thinking capabilities by adding the thinking parameter. While this improves Claude's reasoning for complex tasks, the OpenAI SDK doesn't return Claude's detailed thought process. For full extended thinking features, including access to Claude's step-by-step reasoning output, use the native Claude API.

import os

from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("ANTHROPIC_API_KEY"),
    base_url="https://api.anthropic.com/v1/",
)

response = client.chat.completions.create(
    model="claude-sonnet-4-6",
    messages=[{"role": "user", "content": "Who are you?"}],
    extra_body={"thinking": {"type": "enabled", "budget_tokens": 2000}},
)
const response = await openai.chat.completions.create({
  messages: [{ role: "user", content: "Who are you?" }],
  model: "claude-sonnet-4-6",
  // @ts-expect-error
  thinking: { type: "enabled", budget_tokens: 2000 }
});

Rate limits

Rate limits follow Anthropic's standard limits for the /v1/messages endpoint.

Detailed OpenAI compatible API support

Request fields

Simple fields

FieldSupport status
modelUse Claude model names
max_tokensFully supported
max_completion_tokensFully supported
streamFully supported
stream_optionsFully supported
top_pFully supported
parallel_tool_callsFully supported
stopAll non-whitespace stop sequences work
temperatureBetween 0 and 1 (inclusive). Values greater than 1 are capped at 1.
nMust be exactly 1
logprobsIgnored
metadataIgnored
response_formatIgnored. For JSON output, use Structured Outputs with the native Claude API
predictionIgnored
presence_penaltyIgnored
frequency_penaltyIgnored
seedIgnored
service_tierIgnored
audioIgnored
logit_biasIgnored
storeIgnored
userIgnored
modalitiesIgnored
top_logprobsIgnored
reasoning_effortIgnored

tools / functions fields

Show fields

tools[n].function fields

FieldSupport status
nameFully supported
descriptionFully supported
parametersFully supported
strictIgnored. Use Structured Outputs with native Claude API for strict schema validation

functions[n] fields

Info

OpenAI has deprecated the functions field and suggests using tools instead.

FieldSupport status
nameFully supported
descriptionFully supported
parametersFully supported
strictIgnored. Use Structured Outputs with native Claude API for strict schema validation

messages array fields

Show fields

Fields for messages[n].role == "developer"

Info

Developer messages are hoisted to beginning of conversation as part of the initial system message

FieldSupport status
contentFully supported, but hoisted
nameIgnored

Fields for messages[n].role == "system"

Info

System messages are hoisted to beginning of conversation as part of the initial system message

FieldSupport status
contentFully supported, but hoisted
nameIgnored

Fields for messages[n].role == "user"

FieldVariantSub-fieldSupport status
contentstringFully supported
array, type == "text"Fully supported
array, type == "image_url"urlFully supported
detailIgnored
array, type == "input_audio"Ignored
array, type == "file"Ignored
nameIgnored

Fields for messages[n].role == "assistant"

FieldVariantSupport status
contentstringFully supported
array, type == "text"Fully supported
array, type == "refusal"Ignored
tool_callsFully supported
function_callFully supported
audioIgnored
refusalIgnored

Fields for messages[n].role == "tool"

FieldVariantSupport status
contentstringFully supported
array, type == "text"Fully supported
tool_call_idFully supported
tool_choiceFully supported
nameIgnored

Fields for messages[n].role == "function"

FieldVariantSupport status
contentstringFully supported
array, type == "text"Fully supported
tool_choiceFully supported
nameIgnored

Response fields

FieldSupport status
idFully supported
choices[]Will always have a length of 1
choices[].finish_reasonFully supported
choices[].indexFully supported
choices[].message.roleFully supported
choices[].message.contentFully supported
choices[].message.tool_callsFully supported
objectFully supported
createdFully supported
modelFully supported
finish_reasonFully supported
contentFully supported
usage.completion_tokensFully supported
usage.prompt_tokensFully supported
usage.total_tokensFully supported
usage.completion_tokens_detailsAlways empty
usage.prompt_tokens_detailsAlways empty
choices[].message.refusalAlways empty
choices[].message.audioAlways empty
logprobsAlways empty
service_tierAlways empty
system_fingerprintAlways empty

Error message compatibility

The compatibility layer maintains consistent error formats with the OpenAI API. However, the detailed error messages will not be equivalent. Only use the error messages for logging and debugging.

Header compatibility

While the OpenAI SDK automatically manages headers, here is the complete list of headers supported by the Claude API for developers who need to work with them directly.

HeaderSupport Status
x-ratelimit-limit-requestsFully supported
x-ratelimit-limit-tokensFully supported
x-ratelimit-remaining-requestsFully supported
x-ratelimit-remaining-tokensFully supported
x-ratelimit-reset-requestsFully supported
x-ratelimit-reset-tokensFully supported
retry-afterFully supported
request-idFully supported
openai-versionAlways 2020-10-01
authorizationFully supported
openai-processing-msAlways empty