xAI API

O que é o xAI API?

O xAI API é uma interface para desenvolvedores usarem os modelos Grok da xAI diretamente no código da sua aplicação. O propósito principal da API é receber prompts (e, para alguns modelos, imagens) e retornar respostas geradas que você pode exibir, processar ou estruturar para uso posterior.

O quickstart guia pelo fluxo completo: crie uma conta xAI e adicione créditos, gere uma chave de API, instale um SDK e envie sua primeira solicitação para um modelo Grok usando endpoints e exemplos suportados.

Principais Recursos

• Autenticação por chave de API via variável de ambiente: Configure seu código com XAI_API_KEY, que os SDKs da xAI leem automaticamente.
• Suporte a SDK para linguagens comuns: Instale o SDK da xAI para Python ou JavaScript para chamar modelos Grok sem escrever requisições HTTP raw.
• Geração de texto no estilo chat: Envie mensagens de sistema e usuário e amostre a saída do modelo para respostas em texto.
• Compatibilidade com endpoint de responses: Chame https://api.x.ai/v1/responses diretamente com uma chave de API para inferência de modelo.
• Entradas multimodais (texto + imagem): Para modelos que suportam, inclua uma URL de imagem junto com texto em uma única solicitação.
• Saídas Estruturadas (para modelos suportados): Alguns modelos permitem impor um schema de saída para controlar a forma dos resultados gerados.

Como Usar o xAI API

1. Crie uma conta xAI em accounts.x.ai, depois adicione créditos para usar a API.
2. Crie uma chave de API no xAI Console em API Keys.
3. Defina XAI_API_KEY exportando no terminal ou adicionando a um arquivo .env:
   • export XAI_API_KEY="your_api_key"
   • XAI_API_KEY=your_api_key
4. Instale um SDK conforme sua linguagem:
   • Python: pip install xai-sdk
   • JavaScript: npm install ai @ai-sdk/xai zod
5. Envie uma solicitação para um modelo Grok (exemplo usa grok-4.20-reasoning para texto, e grok-4 para imagem+texto). Use os exemplos do SDK ou a requisição HTTP direta para responses.

Casos de Uso

• Construa uma interface de chat para Grok: Crie uma aplicação que envia perguntas do usuário e instruções de sistema opcionais, depois exibe response.content ou completion.output_text.
• Gere texto com endpoint de modelo conhecido: Use o fluxo POST https://api.x.ai/v1/responses para integrar Grok em serviços onde prefere chamadas HTTP diretas.
• Adicione compreensão de imagens a um fluxo de Q&A: Envie uma URL de imagem com um prompt como “O que há nesta imagem?” usando o formato de solicitação multimodal mostrado no quickstart.
• Imponha formatação de saída para processamento posterior: Ao usar um modelo Grok que suporta, aplique Saídas Estruturadas para que os resultados sigam um schema definido por você.
• Execute experimentos rápidos em diferentes runtimes: Alterne entre exemplos Python e JavaScript mantendo a mesma configuração de variável de ambiente (XAI_API_KEY).

FAQ

Como autentico solicitações no xAI API?

Crie uma chave de API no xAI Console e defina como XAI_API_KEY (ex.: via export XAI_API_KEY="..." ou arquivo .env). O SDK da xAI lê essa variável de ambiente automaticamente.

Qual modelo Grok posso usar na minha primeira solicitação?

Os exemplos do quickstart usam grok-4.20-reasoning para geração de texto estilo chat e grok-4 para entrada imagem+texto.

Posso chamar a API sem um SDK?

Sim. O quickstart inclui um exemplo direto de curl que faz POST para https://api.x.ai/v1/responses com corpo JSON contendo model e input.

Como envio imagens para o Grok?

Para modelos que aceitam imagens, inclua uma URL de imagem no input junto com texto (o exemplo usa estrutura input_image / input_text no SDK ou estrutura de conteúdo tipada na chamada responses).

O que são Saídas Estruturadas?

O quickstart menciona que certos modelos suportam Saídas Estruturadas, que permitem impor um schema para a saída do LLM. A página referencia um “Guia de Geração de Texto” dedicado para uso mais aprofundado.

Alternativas

• Use a API de chat/assistentes de outro provedor de LLM: Se seu fluxo é “prompt entra, texto gerado sai”, troque por outra API de fornecedor usando autenticação por chave e formato de solicitação similar.
• Use uma abordagem agnóstica a frameworks para geração de texto: Em vez de SDK específico de fornecedor, construa requisições diretamente contra um endpoint estilo “completions/responses” para manter a integração consistente entre linguagens.
• Use APIs de modelos multimodais: Se sua necessidade principal é compreensão imagem+texto, procure provedores que suportem explicitamente entradas de imagem no schema da API, depois adapte o payload da solicitação.