Compatibilidade com o OpenAI SDK

Primeiros passos com o OpenAI SDK

Para usar o recurso de compatibilidade com o OpenAI SDK, você precisará:

1. Usar um OpenAI SDK oficial
2. Alterar o seguinte
   • Atualizar sua URL base para apontar para a API do Claude
   • Substituir sua chave de API por uma chave de API do Claude
   • Atualizar o nome do modelo para usar um modelo Claude
3. Revisar a documentação abaixo para saber quais recursos são suportados

Exemplo de início rápido

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-8",  # Claude model name
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who are you?"},
    ],
)

print(response.choices[0].message.content)

Limitações importantes de compatibilidade com OpenAI

Comportamento da API

Aqui estão as diferenças mais substanciais em relação ao uso da OpenAI:

• O parâmetro strict para chamadas de função é ignorado, o que significa que não há garantia de que o JSON de uso de ferramentas siga o schema fornecido. Para conformidade garantida com o schema, use a API do Claude nativa com Structured Outputs.
• Entrada de áudio não é suportada; ela será simplesmente ignorada e removida da entrada
• Cache de prompt não é suportado, mas é suportado nos SDKs da Anthropic
• Mensagens de sistema/desenvolvedor são movidas e concatenadas no início da conversa, já que a Anthropic suporta apenas uma única mensagem de sistema inicial.

A maioria dos campos não suportados é ignorada silenciosamente em vez de produzir erros. Todos eles estão documentados abaixo.

Considerações sobre qualidade da saída

Se você fez muitos ajustes no seu prompt, é provável que ele esteja bem otimizado especificamente para a OpenAI. Considere usar o aprimorador de prompts no Claude Console como um bom ponto de partida.

Movimentação de mensagens de sistema / desenvolvedor

A maioria das entradas do OpenAI SDK mapeia claramente de forma direta para os parâmetros da API da Anthropic, mas uma diferença distinta é o tratamento de prompts de sistema / desenvolvedor. Esses dois tipos de prompt podem ser inseridos ao longo de uma conversa de chat via OpenAI. Como a Anthropic suporta apenas uma mensagem de sistema inicial, a API 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 uma única mensagem de sistema no início das mensagens.

Suporte a pensamento estendido

Você pode habilitar as capacidades de pensamento estendido adicionando o parâmetro thinking. Embora isso melhore o raciocínio do Claude para tarefas complexas, o OpenAI SDK não retorna o processo de pensamento detalhado do Claude. Para recursos completos de pensamento estendido, incluindo acesso à saída de raciocínio passo a passo do Claude, use a API do Claude nativa.

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}},
)

Limites de taxa

Os limites de taxa seguem os limites padrão da Anthropic para o endpoint /v1/messages.

Suporte detalhado da API compatível com OpenAI

Campos de requisição

Campos simples

Campos tools / functions

Campos do array messages

Campos de resposta

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 registro em log e depuração.

Compatibilidade de cabeçalhos

Embora o OpenAI SDK gerencie cabeçalhos automaticamente, aqui está a lista completa de cabeçalhos suportados pela API do Claude para desenvolvedores que precisam trabalhar com eles diretamente.