Base URL and SDK Migration14 de julho de 2026Flatkey

Nomes de Modelos Compatíveis com OpenAI: Evite Erros de Alias, Provedor e Versão

Um checklist prático para verificar nomes de modelos compatíveis com OpenAI, IDs de modelo do provedor, aliases Flatkey, famílias de endpoints e políticas de versão antes da migração.

Nomes de Modelos Compatíveis com OpenAI: Evite Erros de Alias, Provedor e Versão

Nomes de modelos compatíveis com OpenAI são o ponto discreto onde migrações que, de resto, estão limpas, quebram. O SDK aceita uma string model, a forma da requisição parece familiar e a URL base aponta para uma rota compatível com OpenAI. Então a produção vê model_not_found, um fallback silencioso para a capacidade errada ou um modelo de imagem enviado para um endpoint de chat.

A correção não é memorizar o catálogo de cada provedor. Trate os nomes de modelos compatíveis com OpenAI como configuração controlada: cada string pertence a um catálogo de provedor, a uma família de endpoint, a uma rota, a uma política de versão e a um registro de cobrança. Verifique os cinco antes de mover tráfego real.

Flatkey é útil aqui porque as equipes podem centralizar o acesso a modelos, roteamento, cobrança, análise de uso e revisão operacional atrás de um único gateway. Mas um gateway não torna strings de modelo soltas seguras. Este guia dá um fluxo de verificação para nomes de modelos compatíveis com OpenAI antes de você alterar uma URL base, configuração de SDK ou alias de produção.

Por que os Nomes de Modelos Compatíveis com OpenAI Desviam

"Compatível com OpenAI" descreve uma forma de API, não um padrão universal de nomes. Um endpoint compatível pode aceitar JSON e SDKs no estilo OpenAI e ainda assim exigir seus próprios IDs de modelo.

Isso significa que estas strings não são intercambiáveis:

De Onde Veio A String Por Que Pode Falhar
Página de marketing do provedor O nome do produto exibido pode não ser o ID do modelo na API.
Exemplo de código antigo O modelo pode estar descontinuado, renomeado ou restrito a um endpoint diferente.
Outro gateway Aliases de gateway são configuração de roteamento local, não a verdade de todo o provedor.
Uma família de endpoint diferente Rotas de chat, Responses, embeddings, imagem, áudio e vídeo podem expor conjuntos diferentes de modelos.
Outra região ou workspace Alguns provedores fazem o endpoint e o catálogo de modelos dependerem de região, workspace ou acesso da conta.

A regra segura é simples: não aprove nomes de modelos compatíveis com OpenAI de memória. Aprove-os a partir do catálogo atual, da família de endpoint atual e de um teste rápido.

O Fluxo de Verificação do Nome do Modelo

Use este fluxo antes de alterar OPENAI_BASE_URL, baseURL, model, um alias do Flatkey ou uma política de roteamento de produção.

Etapa Pergunta Evidência Para Salvar
1. Catálogo O catálogo atual do provedor ou do Flatkey expõe esta string exata de modelo? Captura de tela, retorno da API ou exportação do catálogo com carimbo de data/hora.
2. Família de endpoint O modelo está habilitado para chat/completions, responses, imagens, embeddings ou outra rota? Documentação específica da rota e uma requisição mínima.
3. Proprietário do alias O aplicativo está usando um ID direto do provedor ou um alias do gateway? Arquivo de configuração, alias de modelo do Flatkey e campo de proprietário/equipe.
4. Política de versão A string é estável, datada, de prévia, descontinuada ou roteada pelo provedor? Nota de descontinuação, página do modelo, changelog ou registro de aprovação.
5. Prova em runtime O ambiente exato do app chama a rota com sucesso? Resposta do curl, resposta do SDK, ID da requisição e registro de uso.
6. Rollback Que string e rota você restaura se falhar? Configuração anterior, feature flag e responsável pelo rollback.

Esse é o valor central de uma checklist de nomes de modelo: ela transforma nomes de modelos compatíveis com OpenAI de strings ad hoc em entradas de implantação revisadas.

Exemplos Atuais de Provedores para Aprender

Use a documentação oficial para entender o padrão e, depois, verifique seu próprio catálogo de conta ou gateway antes de colocar em produção.

Caminho do Provedor Padrão Oficial Verificado Em 7 de Julho de 2026 Lição de Migração
OpenAI A API usa um campo model para Chat Completions e Responses, e o endpoint List models retorna modelos disponíveis para a conta autenticada. A orientação atual de modelos da OpenAI identifica gpt-5.5 como a família mais recente, enquanto exemplos de API ainda podem mostrar strings de exemplo mais antigas. Use a documentação para o contrato, mas use o catálogo da conta para disponibilidade.
Compatibilidade OpenAI do Google Gemini O Google documenta uma URL base compatível com OpenAI em https://generativelanguage.googleapis.com/v1beta/openai/ e exemplos como gemini-3.5-flash para chat. Não substitua um modelo Gemini por um nome com aparência de OpenAI. Mantenha o ID Gemini.
xAI A documentação da xAI mostra uso do SDK OpenAI com base_url="https://api.x.ai/v1" e strings de modelo de exemplo como grok-build-0.1. O SDK pode ter formato de OpenAI, enquanto a string do modelo continua específica da xAI.
Alibaba Cloud DashScope O DashScope documenta o modo compatível com OpenAI para modelos Qwen, URLs compatible-mode/v1 específicas de região ou workspace, e exemplos como qwen-plus. URL base, região, workspace e nome do modelo formam um pacote. Verifique-os juntos.
Flatkey A página pública inicial do Flatkey mostra uma rota no estilo OpenAI em https://router.flatkey.ai/v1/chat/completions e posiciona o produto em torno de uma chave, acesso a modelos, roteamento, cobrança, análise de uso e controles operacionais. Use o console ou catálogo atual do Flatkey para o alias real e, depois, faça um smoke test da rota exata.

Estes exemplos mostram por que os nomes de modelos compatíveis com OpenAI devem ser tratados como strings específicas do provedor. A compatibilidade reduz mudanças no cliente; ela não apaga as diferenças de catálogo.

Crie Um Mapa Aprovado de Modelos

Não espalhe strings de modelos brutas pelo código da aplicação, notebooks, ferramentas de automação e scripts de suporte. Coloque os nomes de modelos compatíveis com OpenAI aprovados em um único mapa pequeno e roteie todo serviço por meio dele.

type EndpointFamily = "chat" | "responses" | "embeddings" | "images" | "video";

type ApprovedModelRoute = {
  alias: string;
  providerModel: string;
  endpointFamily: EndpointFamily;
  baseURL: string;
  owner: string;
  reviewedAt: string;
  rollbackAlias: string;
};

export const models: Record<string, ApprovedModelRoute> = {
  support_chat: {
    alias: "support_chat",
    providerModel: process.env.FLATKEY_SUPPORT_CHAT_MODEL!,
    endpointFamily: "chat",
    baseURL: process.env.FLATKEY_BASE_URL ?? "https://router.flatkey.ai/v1",
    owner: "support-platform",
    reviewedAt: "2026-07-07",
    rollbackAlias: "support_chat_previous",
  },
};

O mapa separa o nome que sua aplicação usa da string do modelo do provedor ou gateway. Isso dá a compras, finanças e equipes de resposta a incidentes um lugar estável para perguntar: quem aprovou este modelo, para qual endpoint ele serve e como fazemos o rollback?

Para uma governança mais ampla do catálogo, combine isso com o guia de catálogo de modelos de IA. Para migração de base URL, use o guia de migração de API compatível com OpenAI.

Teste o Nome Exato Antes da Migração do SDK

Um smoke test de nome de modelo deve ser pequeno o suficiente para inspecionar manualmente. Não comece com ferramentas, streaming, esquema JSON ou um wrapper de framework. Comece pela rota, chave e string do modelo que você planeja entregar.

export FLATKEY_API_KEY="sk-fk-..."
export FLATKEY_BASE_URL="https://router.flatkey.ai/v1"
export FLATKEY_MODEL="the-current-flatkey-model-alias"

curl -sS "$FLATKEY_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $FLATKEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$FLATKEY_MODEL"'",
    "messages": [
      {"role": "user", "content": "Responda exatamente: model route ok"}
    ]
  }'

Se isso falhar, não depure o SDK. Verifique primeiro a string do modelo, a família do endpoint, o escopo da chave, a rota e o catálogo. Se funcionar, salve o corpo da resposta, o código de status, o ID da requisição, se houver, o carimbo de data/hora, o objeto de uso e a leitura de uso do Flatkey.

Depois teste os mesmos nomes de modelos compatíveis com OpenAI pelo SDK:

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.FLATKEY_API_KEY,
  baseURL: process.env.FLATKEY_BASE_URL ?? "https://router.flatkey.ai/v1",
});

const response = await client.chat.completions.create({
  model: process.env.FLATKEY_MODEL!,
  messages: [{ role: "user", content: "Responda exatamente: sdk route ok" }],
});

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

O teste do SDK deve usar a mesma raiz de base URL, o mesmo alias de modelo e a mesma família de endpoint. Se o curl funcionar, mas o SDK falhar, inspecione as variáveis de ambiente antes de alterar os nomes dos modelos.

Separe Aliases de IDs do Provedor

Um alias não é a mesma coisa que um ID de provedor. Um ID de provedor é a string aceita pelo provedor upstream ou pela rota compatível com o provedor. Um alias de gateway é a string que seu gateway mapeia para um modelo do provedor, política de fallback, grupo de preço ou conta.

Ambos podem ser válidos. Os problemas começam quando as equipes deixam de rotular qual deles estão usando.

Use esta disciplina de nomenclatura:

Campo Formato de Exemplo Regra
Alias da app support_chat Nome estável usado pela sua aplicação.
Alias do gateway support-chat-balanced De propriedade da equipe de gateway ou plataforma.
ID do modelo do provedor qwen-plus, gemini-3.5-flash ou valor atual do catálogo Verificado na documentação do provedor ou no catálogo.
Família do endpoint chat, responses, images, embeddings Deve corresponder à rota e ao parser.
Estado da versão stable, preview, dated, deprecated Revisado antes do tráfego de produção.

Isso torna os nomes de modelos compatíveis com OpenAI auditáveis. Se uma rota falhar, você pode identificar se o problema é o alias da app, o alias do Flatkey, o ID do modelo do provedor ou a família do endpoint.

Evite Incompatibilidades de Família de Endpoint

model_not_found nem sempre significa que a string foi escrita incorretamente. Pode significar que a string é válida em outra rota.

Um modelo de chat pode não estar disponível em uma rota Responses. Um modelo de imagem pode usar um endpoint de geração de imagens. Um modelo de vídeo pode exigir uma família de payload diferente. Uma camada de compatibilidade com o provedor pode ignorar silenciosamente campos não suportados ou expor apenas parte do catálogo do provedor.

Antes de adicionar parâmetros opcionais, responda a estas perguntas:

  1. Este modelo está aprovado para a rota que estou chamando?
  2. Este endpoint espera messages, input, prompt, imagens, arquivos ou outro formato de solicitação?
  3. O SDK selecionado acrescenta o caminho do endpoint após a URL base?
  4. O provedor exige uma URL base específica por região ou por workspace?
  5. O Flatkey roteia este alias para a mesma família de endpoint em staging e produção?

O guia de troubleshooting da API compatível com OpenAI cobre o caminho mais amplo de depuração. Para trabalho com nomes de modelos, mantenha a falha pequena: uma rota, uma string de modelo, uma solicitação curta.

Planeje Mudanças de Versão e Depreciação

Os nomes de modelos compatíveis com OpenAI mudam ao longo do tempo. Alguns nomes são famílias estáveis, alguns são snapshots com data, alguns são modelos de prévia e alguns são aliases de gateway que sua própria equipe controla.

Crie uma cadência de revisão para cada rota de modelo em produção:

Sinal Ação
Nova família de modelo do provedor Adicione apenas ao staging e depois compare qualidade, custo, latência e comportamento das ferramentas.
Sufixo de preview ou beta Exija um responsável e uma data de rollback antes do uso em produção.
Aviso de depreciação Crie uma tarefa de migração com prazo, substituição, plano de teste e responsável pela rota.
Mudança de alias do gateway Execute o teste de fumaça e a leitura de uso antes de atualizar a configuração de produção.
Mudança de região do provedor Verifique novamente a URL base, o workspace, o catálogo, o faturamento e a latência.

Não esconda essas decisões apenas em variáveis de ambiente. Mantenha as evidências em um pacote revisável para que engenharia, operações e compras possam ver por que o modelo é अनुमति? Actually Portuguese: "permitido"? We need natural. Let's continue correctly.

O Que Verificar No Flatkey Antes da Troca

Use o Flatkey como ponto de controle operacional, e não como motivo para pular a verificação.

Antes de mover o tráfego de produção, confirme:

  1. A URL base atual do Flatkey no seu console ou nas notas de onboarding.
  2. O alias exato do modelo que você enviará pelo app.
  3. O modelo do provedor ou a rota por trás do alias.
  4. A família de endpoint, como Chat Completions ou Responses.
  5. Os limites de quota e gasto para a chave ou workspace.
  6. A leitura de uso após um teste de fumaça bem-sucedido.
  7. O comportamento de fallback se a rota principal falhar.
  8. A configuração de rollback para a rota anterior do provedor ou o alias anterior do Flatkey.

Depois, compare o lado operacional em preços do Flatkey e obtenha uma chave para um caminho de teste. Trate as páginas de preços e do catálogo de modelos como evidência atual apenas quando você as verificar no dia da migração.

Perguntas frequentes

Os nomes de modelos compatíveis com OpenAI são universais?

Não. Os nomes de modelos compatíveis com OpenAI ainda são strings específicas do provedor ou do gateway. O formato da solicitação pode ser compatível enquanto o catálogo de modelos permanece diferente.

Por que minha rota compatível com OpenAI retorna model_not_found?

A string do modelo pode estar com erro de digitação, indisponível para a conta, desativada no gateway, enviada para a família de endpoint errada, restrita a outra região ou descontinuada. Verifique a string exata no catálogo atual e execute um teste mínimo de rota.

Devo usar IDs de modelo diretos do provedor ou aliases do Flatkey?

Use um alias do Flatkey quando quiser roteamento centralizado, faturamento, revisão de uso, controle de fallback ou governança em nível de equipe. Mantenha o alias mapeado para um ID de modelo do provedor verificado e documente o responsável.

Posso copiar um nome de modelo de um guia antigo do provedor?

Apenas como ponto de partida. Guias antigos podem conter strings descontinuadas, de preview ou apenas de exemplo. Verifique novamente a documentação atual do provedor, o catálogo atual do Flatkey e faça um teste de fumaça ao vivo.

O que deve constar em uma revisão de mudança de nome de modelo?

Inclua a string antiga, a nova string, a família de endpoint, a URL base, o provedor ou alias do Flatkey, o responsável, a documentação de origem, a resposta do teste de fumaça, a leitura de uso, o impacto de custo esperado, o comportamento de fallback e o plano de rollback.

Conclusão

Os nomes de modelos compatíveis com OpenAI são entradas de migração, não trivialidades. Verifique o catálogo, a família de endpoint, o responsável pelo alias, a política de versão e a prova em runtime antes de mudar o tráfego de produção. Se você centralizar essas verificações no Flatkey, a mesma evidência do nome do modelo pode apoiar a transição de engenharia, a revisão de incidentes, a reconciliação de uso e a aprovação de compras.

Quando estiver pronto para testar, comece com uma chave, uma URL base, uma família de endpoint e um alias de modelo aprovado. Essa é a maneira mais rápida de tornar os nomes de modelos compatíveis com OpenAI tranquilos o suficiente para produção.