Usar o console
O AI Hub começa pelo cadastro de uma API Key. Depois, selecione o modelo que deseja usar na aba Modelos e integre-o à sua aplicação pela API.
Como acessar
O acesso ao AI Hub é concedido mediante solicitação. Portanto, antes de seguir este guia, solicite acesso pela página do AI Hub e aguarde a liberação para a sua conta.
Sendo liberado, acesse o console da Magalu Cloud e abra o AI Hub pelo menu lateral ou pelo card correspondente na página inicial.
Visão geral
A tela inicial apresenta o botão Criar chave de API e três abas, nesta ordem:
- Chaves de API — criação, consulta e gerenciamento das chaves.
- Modelos — consulta dos modelos disponíveis e do uso associado.
- Playground — testes interativos com um modelo e uma chave.
Os cards de resumo mostram chaves ativas, total de requisições, tokens usados e custo total. Os dados de consumo são atualizados conforme o uso do serviço.
1. Criar uma API Key
Acesse a aba Chaves de API e clique em Criar chave de API.
- Informe a validade e um nome para identificar a chave, por exemplo integracao-backend.
- Confirme a criação.
- Guarde a chave em um local seguro e use-a para autenticar chamadas.
As chaves aparecem na lista da aba Chaves de API. Use a busca e os filtros para localizar uma chave. Cada linha mostra o nome, a informação de expiração quando disponível e o status. Abra o menu da linha para consultar as ações disponíveis.
Trate a API Key como uma senha. Não a inclua em código-fonte público nem a compartilhe. Se uma chave for exposta, inative-a imediatamente e crie outra.
2. Consultar e gerenciar chaves
Na aba Chaves de API, consulte as chaves existentes e verifique se estão Ativas ou Inativas. Abra uma chave para visualizar e consultar os detalhes relacionados.
A API Key é criada separadamente do modelo. Você pode selecionar a chave e o modelo que deseja usar no Playground; nas chamadas feitas pela sua aplicação, informe a chave no cabeçalho de autorização e o identificador do modelo no corpo da requisição.
3. Consultar modelos
Abra a aba Modelos para consultar o catálogo e as informações disponíveis para cada modelo, como provedor, contexto e preço por milhão de tokens. Os identificadores aceitos pela API podem ser diferentes do nome amigável exibido no catálogo; use o identificador mostrado nos detalhes do modelo.
Consulte também a página Modelos disponíveis para conhecer as finalidades dos modelos e Preços e cobrança para entender a precificação.
4. Integrar com sua aplicação
A API do AI Hub é compatível com o padrão OpenAI. Use a Base URL e a API Key exibidas no console. Selecione o identificador do modelo na aba Modelos.
Exemplo em Python:
from openai import OpenAI
client = OpenAI(
api_key="SUA_API_KEY",
base_url="SUA_BASE_URL/v1",
)
response = client.chat.completions.create(
model="IDENTIFICADOR_DO_MODELO",
messages=[{"role": "user", "content": "Olá!"}],
)
print(response.choices[0].message.content)
Guarde a chave em uma variável de ambiente ou em um gerenciador de segredos. Não grave credenciais diretamente no código da aplicação.
5. Abrir o Playground
O Playground tem uma página própria nesta documentação: Playground do AI Hub. Nela, você escolhe uma modalidade, seleciona o modelo e uma API Key e envia entradas de teste sem escrever código.
Perguntas frequentes
Preciso ativar um modelo antes de criar uma chave?
Não. Crie primeiro a API Key na aba Chaves de API. Em seguida, selecione um modelo no Playground ou informe seu identificador ao chamar a API.
Onde encontro a Base URL e o identificador do modelo?
A Base URL fica nos detalhes apresentados pelo console para a chave. Consulte o identificador do modelo na aba Modelos.
Posso usar uma chave com mais de um modelo?
Sim, a chave tem acesso ao setup completo modelos.
Onde acompanho o consumo?
Os cards de resumo na tela inicial mostram requisições, tokens e custo. Os detalhes da Chave de API oferecem informações adicionais de uso e consumo.