---
title: Compatibilidade com o SDK da OpenAI
url: https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/libraries/openai-sdk
description: A Anthropic fornece uma camada de compatibilidade que permite que você use o SDK da OpenAI para testar a Claude API. Com algumas alterações de código, você pode avaliar rapidamente as capacidades dos modelos da Anthropic.
---
Esta camada de compatibilidade destina-se principalmente a testar e comparar capacidades de modelos, e não é considerada uma solução de longo prazo ou pronta para produção para a maioria dos casos de uso. Embora a intenção seja que ela permaneça totalmente funcional e não tenha alterações incompatíveis, a prioridade é a confiabilidade e a eficácia da [Claude API](https://platform.claude.com/docs/pt-BR/api/overview).
Para mais informações sobre limitações de compatibilidade conhecidas, consulte [Limitações importantes de compatibilidade com a OpenAI](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/libraries/openai-sdk#important-openai-compatibility-limitations).
Se você encontrar qualquer problema com o recurso de compatibilidade com o SDK da OpenAI, compartilhe seu feedback por meio deste [formulário de feedback de compatibilidade](https://forms.gle/oQV4McQNiuuNbz9n8).
Para a melhor experiência e acesso ao conjunto completo de recursos da Claude API ([processamento de PDF](https://platform.claude.com/docs/pt-BR/build-with-claude/pdf-support), [citações](https://platform.claude.com/docs/pt-BR/build-with-claude/citations), [pensamento](https://platform.claude.com/docs/pt-BR/build-with-claude/thinking) e [cache de prompt](https://platform.claude.com/docs/pt-BR/build-with-claude/prompt-caching)), use a [Claude API](https://platform.claude.com/docs/pt-BR/api/overview) nativa.
## Primeiros passos com o SDK da OpenAI
Para usar o recurso de compatibilidade com o SDK da OpenAI, você precisará:
1. Usar um SDK oficial da OpenAI
2. Alterar o seguinte
* Atualize sua URL base para apontar para a Claude API
* Substitua sua chave de API por uma [chave de API do Claude](https://platform.claude.com/settings/keys)
* Se sua chave for uma [chave pessoal ou de conta de serviço](https://platform.claude.com/docs/pt-BR/manage-claude/authentication#key-types) com acesso a vários workspaces, envie também o cabeçalho `anthropic-workspace-id` em cada requisição (por exemplo, `default_headers` no SDK Python ou `defaultHeaders` no TypeScript); consulte [Selecionar um workspace](https://platform.claude.com/docs/pt-BR/manage-claude/authentication#select-a-workspace)
* Atualize o nome do seu modelo para usar um [modelo Claude](https://platform.claude.com/docs/pt-BR/models/overview)
3. Revisar as seções a seguir para saber quais recursos são suportados
### Exemplo de início rápido
```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-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: process.env.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: "system", content: "You are a helpful assistant." },
{ role: "user", content: "Who are you?" }
],
model: "claude-opus-5-5" // Claude model name
});
console.log(response.choices[0].message.content);
```
```csharp C#
using System.ClientModel;
using OpenAI;
using OpenAI.Chat;
ChatClient chatClient = new(
model: "claude-opus-5-5", // Claude model name
credential: new ApiKeyCredential(
Environment.GetEnvironmentVariable("ANTHROPIC_API_KEY")), // Your Claude API key
options: new OpenAIClientOptions()
{
Endpoint = new Uri("https://api.anthropic.com/v1/") // the Claude API endpoint
});
ChatCompletion completion = chatClient.CompleteChat(
new SystemChatMessage("You are a helpful assistant."),
new UserChatMessage("Who are you?"));
Console.WriteLine(completion.Content[0].Text);
```
```go Go
package main
import (
"context"
"fmt"
"os"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey(os.Getenv("ANTHROPIC_API_KEY")), // Your Claude API key
option.WithBaseURL("https://api.anthropic.com/v1/"), // the Claude API endpoint
)
response, err := client.Chat.Completions.New(context.Background(), openai.ChatCompletionNewParams{
Model: "claude-opus-5-5", // Claude model name
Messages: []openai.ChatCompletionMessageParamUnion{
openai.SystemMessage("You are a helpful assistant."),
openai.UserMessage("Who are you?"),
},
})
if err != nil {
panic(err)
}
fmt.Println(response.Choices[0].Message.Content)
}
```
```java Java
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionCreateParams;
public class QuickStart {
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.builder()
.apiKey(System.getenv("ANTHROPIC_API_KEY")) // Your Claude API key
.baseUrl("https://api.anthropic.com/v1/") // the Claude API endpoint
.build();
ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
.model("claude-opus-5-5") // Claude model name
.addSystemMessage("You are a helpful assistant.")
.addUserMessage("Who are you?")
.build();
ChatCompletion completion = client.chat().completions().create(params);
System.out.println(completion.choices().get(0).message().content().orElse(""));
}
}
```
A OpenAI não tem um SDK oficial para PHP. Para usar o Claude a partir de PHP, use o [SDK do Claude para PHP](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/sdks/php).
```ruby Ruby
require "openai"
openai = OpenAI::Client.new(
api_key: ENV["ANTHROPIC_API_KEY"], # Your Claude API key
base_url: "https://api.anthropic.com/v1/" # the Claude API endpoint
)
response = openai.chat.completions.create(
model: "claude-opus-5-5", # Claude model name
messages: [
{role: "system", content: "You are a helpful assistant."},
{role: "user", content: "Who are you?"}
]
)
puts response.choices.first.message.content
```
## Limitações importantes de compatibilidade com a OpenAI
### Comportamento da API
Aqui estão as diferenças mais substanciais em relação ao uso da OpenAI:
* O parâmetro `strict` para chamada de funções é ignorado, o que significa que não há garantia de que o JSON de uso de ferramentas siga o esquema fornecido. Para conformidade garantida com o esquema, use a [Claude API nativa com Structured Outputs](https://platform.claude.com/docs/pt-BR/build-with-claude/structured-outputs).
* Entrada de áudio não é suportada; ela será ignorada e removida da entrada
* O "prompt caching" (cache de prompt) não é suportado, mas é suportado nos [SDKs da Anthropic](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/overview)
* Mensagens de sistema/desenvolvedor são elevadas e concatenadas no campo `system` de nível superior, onde quer que apareçam na conversa. Para adicionar instruções de sistema no meio de uma conversa, use [mensagens de sistema no meio da conversa](https://platform.claude.com/docs/pt-BR/build-with-claude/mid-conversation-system-messages) na Claude API nativa.
A maioria dos campos não suportados é ignorada silenciosamente em vez de produzir erros. Todos eles estão documentados nas seções a seguir.
### Considerações sobre a qualidade da saída
Se você fez muitos ajustes no seu prompt, é provável que ele esteja bem ajustado especificamente para a OpenAI. Considere reformulá-lo para o Claude usando o [guia de melhores práticas de prompting](https://platform.claude.com/docs/pt-BR/build-with-claude/prompt-engineering/claude-prompting-best-practices).
### Elevação de mensagens de sistema / desenvolvedor
A maioria das entradas do SDK da OpenAI mapeia claramente de forma direta para os parâmetros da API da Anthropic, mas uma diferença distinta é o tratamento dos prompts de sistema / desenvolvedor. Esses dois prompts podem ser colocados ao longo de uma conversa de chat via OpenAI. A camada de compatibilidade pega todas as mensagens de sistema/desenvolvedor e as concatena com uma única quebra de linha (`\n`) entre elas. Essa string completa é então fornecida como o campo `system` de nível superior, antes de todas as mensagens.
### Suporte a pensamento
Você pode habilitar o [pensamento](https://platform.claude.com/docs/pt-BR/build-with-claude/thinking) adicionando o parâmetro `thinking`. Nos modelos atuais, o pensamento é adaptativo, com o Claude determinando quando e com que profundidade pensar, e nos modelos Claude 5 ele vem ativado por padrão; o "extended thinking" (pensamento estendido) configurado manualmente é um modo legado. Embora o pensamento melhore o raciocínio do Claude em tarefas complexas, o SDK da OpenAI não retorna o pensamento do Claude. Para recursos completos de pensamento, incluindo o [pensamento resumido](https://platform.claude.com/docs/pt-BR/build-with-claude/thinking#summarized-thinking), use a Claude API nativa.
```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 }
});
```
```csharp C#
// O SDK .NET não tem um parâmetro extra_body como o do Python, então este exemplo
// envia o parâmetro thinking com o método de protocolo documentado do SDK
// (um corpo de requisição JSON bruto).
BinaryData input = BinaryData.FromString("""
{
"model": "claude-sonnet-4-6",
"messages": [{ "role": "user", "content": "Who are you?" }],
"thinking": { "type": "enabled", "budget_tokens": 2000 }
}
""");
using BinaryContent content = BinaryContent.Create(input);
ClientResult result = chatClient.CompleteChat(content);
```
```go Go
response, err := client.Chat.Completions.New(
context.Background(),
openai.ChatCompletionNewParams{
Model: "claude-sonnet-4-6",
Messages: []openai.ChatCompletionMessageParamUnion{
openai.UserMessage("Who are you?"),
},
},
option.WithJSONSet("thinking", map[string]any{"type": "enabled", "budget_tokens": 2000}),
)
```
```java Java
ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
.model("claude-sonnet-4-6")
.addUserMessage("Who are you?")
.putAdditionalBodyProperty("thinking",
JsonValue.from(Map.of("type", "enabled", "budget_tokens", 2000)))
.build();
ChatCompletion completion = client.chat().completions().create(params);
```
A OpenAI não tem um SDK oficial para PHP. Para usar o Claude a partir de PHP, use o [SDK do Claude para PHP](https://platform.claude.com/docs/pt-BR/cli-sdks-libraries/sdks/php).
```ruby Ruby
response = openai.chat.completions.create(
model: "claude-sonnet-4-6",
messages: [{role: "user", content: "Who are you?"}],
request_options: {extra_body: {thinking: {type: "enabled", budget_tokens: 2000}}}
)
```
## Limites de taxa
Os "rate limits" (limites de taxa) seguem os [limites padrão](https://platform.claude.com/docs/pt-BR/api/rate-limits) da Anthropic para o endpoint `/v1/messages`.
## Suporte detalhado à API compatível com a OpenAI
### Campos de requisição
#### Campos simples
| Campo | Status de suporte |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `model` | Use nomes de modelos Claude |
| `max_tokens` | Totalmente suportado |
| `max_completion_tokens` | Totalmente suportado |
| `stream` | Totalmente suportado |
| `stream_options` | Totalmente suportado |
| `top_p` | Repassado ao modelo. Os modelos Claude 4.7 e posteriores e o Claude Mythos Preview retornam um erro 400 para qualquer valor diferente de `0.99`, o padrão, portanto omita-o. Uma requisição que define tanto `temperature` quanto `top_p` também retorna um erro 400. Consulte [Trabalhando com mensagens](https://platform.claude.com/docs/pt-BR/build-with-claude/working-with-messages). |
| `parallel_tool_calls` | Totalmente suportado |
| `stop` | Todas as sequências de parada que não sejam espaços em branco funcionam |
| `temperature` | Entre 0 e 1 (inclusive). Valores maiores que 1 são limitados a 1. Nos modelos Claude 4.7 e posteriores e no Claude Mythos Preview, qualquer valor abaixo de 1 retorna um erro 400, portanto omita-o. Consulte [Trabalhando com mensagens](https://platform.claude.com/docs/pt-BR/build-with-claude/working-with-messages). |
| `n` | Deve ser exatamente 1 |
| `logprobs` | Ignorado |
| `metadata` | Ignorado |
| `response_format` | Ignorado. Para saída JSON, use [Structured Outputs](https://platform.claude.com/docs/pt-BR/build-with-claude/structured-outputs) com a Claude API nativa |
| `prediction` | Ignorado |
| `presence_penalty` | Ignorado |
| `frequency_penalty` | Ignorado |
| `seed` | Ignorado |
| `service_tier` | Ignorado |
| `audio` | Ignorado |
| `logit_bias` | Ignorado |
| `store` | Ignorado |
| `user` | Ignorado |
| `modalities` | Ignorado |
| `top_logprobs` | Ignorado |
| `reasoning_effort` | Ignorado |
#### Campos `tools` / `functions`
Campos `tools[n].function`
| Campo | Status de suporte |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Totalmente suportado |
| `description` | Totalmente suportado |
| `parameters` | Totalmente suportado |
| `strict` | Ignorado. Use [Structured Outputs](https://platform.claude.com/docs/pt-BR/build-with-claude/structured-outputs) com a Claude API nativa para validação estrita de esquema |
Campos `functions[n]`
A OpenAI descontinuou o campo `functions` e sugere usar `tools` em seu lugar.
| Campo | Status de suporte |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | Totalmente suportado |
| `description` | Totalmente suportado |
| `parameters` | Totalmente suportado |
| `strict` | Ignorado. Use [Structured Outputs](https://platform.claude.com/docs/pt-BR/build-with-claude/structured-outputs) com a Claude API nativa para validação estrita de esquema |
#### Campos do array `messages`
Campos para `messages[n].role == "developer"`
Mensagens de desenvolvedor são elevadas para o início da conversa como parte da mensagem de sistema inicial
| Campo | Status de suporte |
| --------- | --------------------------------- |
| `content` | Totalmente suportado, mas elevado |
| `name` | Ignorado |
Campos para `messages[n].role == "system"`
Mensagens de sistema são elevadas para o início da conversa como parte da mensagem de sistema inicial
| Campo | Status de suporte |
| --------- | --------------------------------- |
| `content` | Totalmente suportado, mas elevado |
| `name` | Ignorado |
Campos para `messages[n].role == "user"`
| Campo | Variante | Subcampo | Status de suporte |
| --------- | -------------------------------- | -------- | -------------------- |
| `content` | `string` | | Totalmente suportado |
| | `array`, `type == "text"` | | Totalmente suportado |
| | `array`, `type == "image_url"` | `url` | Totalmente suportado |
| | | `detail` | Ignorado |
| | `array`, `type == "input_audio"` | | Ignorado |
| | `array`, `type == "file"` | | Ignorado |
| `name` | | | Ignorado |
Campos para `messages[n].role == "assistant"`
| Campo | Variante | Status de suporte |
| --------------- | ---------------------------- | -------------------- |
| `content` | `string` | Totalmente suportado |
| | `array`, `type == "text"` | Totalmente suportado |
| | `array`, `type == "refusal"` | Ignorado |
| `tool_calls` | | Totalmente suportado |
| `function_call` | | Totalmente suportado |
| `audio` | | Ignorado |
| `refusal` | | Ignorado |
Campos para `messages[n].role == "tool"`
| Campo | Variante | Status de suporte |
| -------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content` | `string` | Totalmente suportado |
| | `array`, `type == "text"` | Totalmente suportado |
| `tool_call_id` | | Totalmente suportado |
| `tool_choice` | | Suportado. Os valores `"required"` e de função nomeada forçam uma chamada de ferramenta; Claude Opus 5.5, Claude Sonnet 5.5, Claude Fable 5.1 e Claude Mythos 5.1 não suportam uso de ferramentas forçado e retornam um erro, portanto use `"auto"` nesses modelos. Consulte [Forçando o uso de ferramentas](https://platform.claude.com/docs/pt-BR/agents-and-tools/tool-use/define-tools#forcing-tool-use). |
| `name` | | Ignorado |
Campos para `messages[n].role == "function"`
| Campo | Variante | Status de suporte |
| ------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `content` | `string` | Totalmente suportado |
| | `array`, `type == "text"` | Totalmente suportado |
| `tool_choice` | | Suportado. Os valores `"required"` e de função nomeada forçam uma chamada de ferramenta; Claude Opus 5.5, Claude Sonnet 5.5, Claude Fable 5.1 e Claude Mythos 5.1 não suportam uso de ferramentas forçado e retornam um erro, portanto use `"auto"` nesses modelos. Consulte [Forçando o uso de ferramentas](https://platform.claude.com/docs/pt-BR/agents-and-tools/tool-use/define-tools#forcing-tool-use). |
| `name` | | Ignorado |
### Campos de resposta
| Campo | Status de suporte |
| --------------------------------- | ------------------------- |
| `id` | Totalmente suportado |
| `choices[]` | Sempre terá comprimento 1 |
| `choices[].finish_reason` | Totalmente suportado |
| `choices[].index` | Totalmente suportado |
| `choices[].message.role` | Totalmente suportado |
| `choices[].message.content` | Totalmente suportado |
| `choices[].message.tool_calls` | Totalmente suportado |
| `object` | Totalmente suportado |
| `created` | Totalmente suportado |
| `model` | Totalmente suportado |
| `finish_reason` | Totalmente suportado |
| `content` | Totalmente suportado |
| `usage.completion_tokens` | Totalmente suportado |
| `usage.prompt_tokens` | Totalmente suportado |
| `usage.total_tokens` | Totalmente suportado |
| `usage.completion_tokens_details` | Sempre vazio |
| `usage.prompt_tokens_details` | Sempre vazio |
| `choices[].message.refusal` | Sempre vazio |
| `choices[].message.audio` | Sempre vazio |
| `logprobs` | Sempre vazio |
| `service_tier` | Sempre vazio |
| `system_fingerprint` | Sempre vazio |
### Compatibilidade de mensagens de erro
A camada de compatibilidade mantém formatos de erro consistentes com a API da OpenAI. No entanto, as mensagens de erro detalhadas não serão equivalentes. Use as mensagens de erro apenas para logging e depuração.
### Compatibilidade de cabeçalhos
Embora o SDK da OpenAI gerencie os cabeçalhos automaticamente, aqui está a lista completa de cabeçalhos suportados pela Claude API para desenvolvedores que precisam trabalhar com eles diretamente.
| Cabeçalho | Status de suporte |
| -------------------------------- | -------------------- |
| `x-ratelimit-limit-requests` | Totalmente suportado |
| `x-ratelimit-limit-tokens` | Totalmente suportado |
| `x-ratelimit-remaining-requests` | Totalmente suportado |
| `x-ratelimit-remaining-tokens` | Totalmente suportado |
| `x-ratelimit-reset-requests` | Totalmente suportado |
| `x-ratelimit-reset-tokens` | Totalmente suportado |
| `retry-after` | Totalmente suportado |
| `request-id` | Totalmente suportado |
| `openai-version` | Sempre `2020-10-01` |
| `authorization` | Totalmente suportado |
| `openai-processing-ms` | Sempre vazio |