Page history
openai-sdk
cli-sdks-libraries/libraries/openai-sdk
History
cli-sdks-libraries/libraries/openai-sdk Changed · +1 / -0 lines
from line 26
* Update your base URL to point to the Claude API * Replace your API key with a [Claude API key](https://platform.claude.com/settings/keys) + * If your key is a [personal or service account key](https://platform.claude.com/docs/en/manage-claude/authentication#key-types) with access to multiple workspaces, also send the `anthropic-workspace-id` header on every request (for example, `default_headers` in the Python SDK or `defaultHeaders` in TypeScript); see [Select a workspace](https://platform.claude.com/docs/en/manage-claude/authentication#select-a-workspace) * Update your model name to use a [Claude model](https://platform.claude.com/docs/en/models/overview) 3. Review the following sections for what features are supported
cli-sdks-libraries/libraries/openai-sdk Changed · +1 / -1 lines
from line 26
* Update your base URL to point to the Claude API * Replace your API key with a [Claude API key](https://platform.claude.com/settings/keys) - * Update your model name to use a [Claude model](https://platform.claude.com/docs/en/about-claude/models/overview) + * Update your model name to use a [Claude model](https://platform.claude.com/docs/en/models/overview) 3. Review the following sections for what features are supported
cli-sdks-libraries/libraries/openai-sdk First recorded · 318 lines, first recorded
## Getting started with the OpenAI SDK ### Quick start example ## Important OpenAI compatibility limitations ### API behavior ### Output quality considerations ### System / developer message hoisting ### Thinking support ## Rate limits ## Detailed OpenAI compatible API support ### Request fields #### Simple fields #### `tools` / `functions` fields #### `messages` array fields ### Response fields ### Error message compatibility ### Header compatibility
The first capture of this source. The page was already there, and this is what it said.
---
title: OpenAI SDK compatibility
url: https://platform.claude.com/docs/en/cli-sdks-libraries/libraries/openai-sdk
description: 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](https://platform.claude.com/docs/en/api/overview).
For more information on known compatibility limitations, see [Important OpenAI compatibility limitations](https://platform.claude.com/docs/en/cli-sdks-libraries/libraries/openai-sdk#important-openai-compatibility-limitations).
If you encounter any issues with the OpenAI SDK compatibility feature, please share your feedback via this [compatibility feedback form](https://forms.gle/oQV4McQNiuuNbz9n8).
</Note>
<Tip>
For the best experience and access to Claude API full feature set ([PDF processing](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [citations](https://platform.claude.com/docs/en/build-with-claude/citations), [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), and [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching)), use the native [Claude API](https://platform.claude.com/docs/en/api/overview).
</Tip>
## 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](https://platform.claude.com/settings/keys)
* Update your model name to use a [Claude model](https://platform.claude.com/docs/en/about-claude/models/overview)
3. Review the following sections for what features are supported
### Quick start example
<CodeGroup>
```python Python
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-5", # Claude model name
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Who are you?"},
],
)
print(response.choices[0].message.content)
```
```typescript TypeScript
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-5" // Claude model name
});
console.log(response.choices[0].message.content);
```
</CodeGroup>
## 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](https://platform.claude.com/docs/en/build-with-claude/structured-outputs).
* Audio input is not supported; it will be ignored and stripped from input
* Prompt caching is not supported, but it is supported in the [Anthropic SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview)
* 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 in the following sections.
### Output quality considerations
If you’ve done lots of tweaking to your prompt, it’s likely to be well-tuned to OpenAI specifically. Consider reworking it for Claude using the [prompting best practices guide](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices).
### 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.
### Thinking support
You can enable [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) by adding the `thinking` parameter. On current models thinking is adaptive, with Claude deciding when and how deeply to think, and on Claude 5 models it is on by default; manually configured extended thinking is a legacy mode. While thinking improves Claude's reasoning for complex tasks, the OpenAI SDK doesn't return Claude's detailed thought process. For full thinking features, including access to Claude's step-by-step reasoning output, use the native Claude API.
<CodeGroup>
```python Python
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}},
)
```
```typescript TypeScript
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 }
});
```
</CodeGroup>
## Rate limits
Rate limits follow Anthropic's [standard limits](https://platform.claude.com/docs/en/api/rate-limits) for the `/v1/messages` endpoint.
## Detailed OpenAI compatible API support
### Request fields
#### Simple fields
| Field | Support status |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `model` | Use Claude model names |
| `max_tokens` | Fully supported |
| `max_completion_tokens` | Fully supported |
| `stream` | Fully supported |
| `stream_options` | Fully supported |
| `top_p` | Fully supported |
| `parallel_tool_calls` | Fully supported |
| `stop` | All non-whitespace stop sequences work |
| `temperature` | Between 0 and 1 (inclusive). Values greater than 1 are capped at 1. |
| `n` | Must be exactly 1 |
| `logprobs` | Ignored |
| `metadata` | Ignored |
| `response_format` | Ignored. For JSON output, use [Structured Outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) with the native Claude API |
| `prediction` | Ignored |
| `presence_penalty` | Ignored |
| `frequency_penalty` | Ignored |
| `seed` | Ignored |
| `service_tier` | Ignored |
| `audio` | Ignored |
| `logit_bias` | Ignored |
| `store` | Ignored |
| `user` | Ignored |
| `modalities` | Ignored |
| `top_logprobs` | Ignored |
| `reasoning_effort` | Ignored |
#### `tools` / `functions` fields
<Accordion title="Show fields">
<Tabs>
<Tab title="Tools">
`tools[n].function` fields
| Field | Support status |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Fully supported |
| `description` | Fully supported |
| `parameters` | Fully supported |
| `strict` | Ignored. Use [Structured Outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) with native Claude API for strict schema validation |
</Tab>
<Tab title="Functions">
`functions[n]` fields
<Info>
OpenAI has deprecated the `functions` field and suggests using `tools` instead.
</Info>
| Field | Support status |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Fully supported |
| `description` | Fully supported |
| `parameters` | Fully supported |
| `strict` | Ignored. Use [Structured Outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) with native Claude API for strict schema validation |
</Tab>
</Tabs>
</Accordion>
#### `messages` array fields
<Accordion title="Show fields">
<Tabs>
<Tab title="Developer role">
Fields for `messages[n].role == "developer"`
<Info>
Developer messages are hoisted to beginning of conversation as part of the initial system message
</Info>
| Field | Support status |
| --------- | ---------------------------- |
| `content` | Fully supported, but hoisted |
| `name` | Ignored |
</Tab>
<Tab title="System role">
Fields for `messages[n].role == "system"`
<Info>
System messages are hoisted to beginning of conversation as part of the initial system message
</Info>
| Field | Support status |
| --------- | ---------------------------- |
| `content` | Fully supported, but hoisted |
| `name` | Ignored |
</Tab>
<Tab title="User role">
Fields for `messages[n].role == "user"`
| Field | Variant | Sub-field | Support status |
| --------- | -------------------------------- | --------- | --------------- |
| `content` | `string` | | Fully supported |
| | `array`, `type == "text"` | | Fully supported |
| | `array`, `type == "image_url"` | `url` | Fully supported |
| | | `detail` | Ignored |
| | `array`, `type == "input_audio"` | | Ignored |
| | `array`, `type == "file"` | | Ignored |
| `name` | | | Ignored |
</Tab>
<Tab title="Assistant role">
Fields for `messages[n].role == "assistant"`
| Field | Variant | Support status |
| --------------- | ---------------------------- | --------------- |
| `content` | `string` | Fully supported |
| | `array`, `type == "text"` | Fully supported |
| | `array`, `type == "refusal"` | Ignored |
| `tool_calls` | | Fully supported |
| `function_call` | | Fully supported |
| `audio` | | Ignored |
| `refusal` | | Ignored |
</Tab>
<Tab title="Tool role">
Fields for `messages[n].role == "tool"`
| Field | Variant | Support status |
| -------------- | ------------------------- | --------------- |
| `content` | `string` | Fully supported |
| | `array`, `type == "text"` | Fully supported |
| `tool_call_id` | | Fully supported |
| `tool_choice` | | Fully supported |
| `name` | | Ignored |
</Tab>
<Tab title="Function role">
Fields for `messages[n].role == "function"`
| Field | Variant | Support status |
| ------------- | ------------------------- | --------------- |
| `content` | `string` | Fully supported |
| | `array`, `type == "text"` | Fully supported |
| `tool_choice` | | Fully supported |
| `name` | | Ignored |
</Tab>
</Tabs>
</Accordion>
### Response fields
| Field | Support status |
| --------------------------------- | ------------------------------ |
| `id` | Fully supported |
| `choices[]` | Will always have a length of 1 |
| `choices[].finish_reason` | Fully supported |
| `choices[].index` | Fully supported |
| `choices[].message.role` | Fully supported |
| `choices[].message.content` | Fully supported |
| `choices[].message.tool_calls` | Fully supported |
| `object` | Fully supported |
| `created` | Fully supported |
| `model` | Fully supported |
| `finish_reason` | Fully supported |
| `content` | Fully supported |
| `usage.completion_tokens` | Fully supported |
| `usage.prompt_tokens` | Fully supported |
| `usage.total_tokens` | Fully supported |
| `usage.completion_tokens_details` | Always empty |
| `usage.prompt_tokens_details` | Always empty |
| `choices[].message.refusal` | Always empty |
| `choices[].message.audio` | Always empty |
| `logprobs` | Always empty |
| `service_tier` | Always empty |
| `system_fingerprint` | Always 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.
Cut at 300 lines.