Ir para o conteúdo principal
Português— Escolher um idioma
Menu

Endpoints disponíveis

Aula 13 de 14 Atualizada a 30 de julho de 2026 Programador
Nesta página
  1. Visão geral da API Grok
  2. Geração de texto
  3. Processamento assíncrono
  4. Geração de imagens
  5. Geração de vídeo
  6. Síntese de fala
  7. Agente de voz em tempo real
  8. Gestão de ficheiros
  9. Processamento em lote
  10. Ferramentas integradas no servidor
  11. Pontos-chave

Visão geral da API Grok

A API da xAI não se limita à geração de texto. Ela expõe um conjunto de endpoints que abrangem a geração de imagens e vídeos, síntese de fala, gestão de ficheiros e processamento assíncrono. Esta lição mapeia os endpoints disponíveis para que saiba quais as funcionalidades a utilizar nos seus projetos.

Geração de texto

POST /v1/responses (recomendado)

O endpoint principal para qualquer interação com os modelos Grok. Suporta texto, visão, ferramentas (chamada de funções), pesquisa na web e pesquisa no X.

Parâmetros principais: model, input, instructions, stream, tools, reasoning.

POST /v1/chat/completions (compatível com OpenAI)

O endpoint no formato da OpenAI, mantido para compatibilidade com ferramentas existentes. Aceita os mesmos parâmetros da API da OpenAI: model, messages, temperature, stream, tools.

GET /v1/responses/{id}

Recupera uma resposta gerada anteriormente, caso tenha sido armazenada (parâmetro store: true). As respostas são mantidas durante 30 dias.

DELETE /v1/responses/{id}

Elimina uma resposta armazenada antes de esta expirar automaticamente após 30 dias.

Processamento assíncrono

POST /v1/chat/completions (modo diferido)

Ao adicionar "deferred": true ao pedido, a API devolve imediatamente um request_id sem aguardar o fim da geração. Isto é útil para pedidos longos ou processamento em lote.

GET /v1/chat/deferred-completion/{request_id}

Recupera o resultado de uma chamada assíncrona:

  • HTTP 200: a geração terminou e o corpo contém a resposta completa
  • HTTP 202: a geração ainda está em curso; tente novamente mais tarde

Geração de imagens

POST /v1/images/generations

Gera imagens a partir de uma descrição textual.

POST /v1/images/edits

Edita uma imagem existente com base em instruções de texto.

Geração de vídeo

POST /v1/videos/generations

Inicia a geração de um vídeo a partir de um prompt de texto.

GET /v1/videos/{id}

Verifica o estado de um vídeo em geração e recupera o URL do resultado assim que este estiver concluído.

POST /v1/videos/edits

Edita um vídeo existente.

POST /v1/videos/extensions

Estende um vídeo existente.

Síntese de fala

POST /v1/tts

Converte texto em áudio (texto-para-fala). Útil para criar assistentes de voz ou conteúdos áudio automatizados.

Agente de voz em tempo real

WSS wss://api.x.ai/v1/realtime

Um endpoint WebSocket para criar agentes de voz interativos. A comunicação ocorre em tempo real, enviando e recebendo áudio.

Gestão de ficheiros

POST /v1/files

Carrega um ficheiro para a plataforma da xAI. Os ficheiros podem depois ser utilizados para RAG (geração aumentada por recuperação) com coleções.

GET /v1/files

Lista todos os ficheiros carregados no seu espaço.

GET /v1/files/{id}

Recupera os metadados de um ficheiro específico.

DELETE /v1/files/{id}

Elimina um ficheiro carregado.

Processamento em lote

POST /v1/batches

Cria um lote de pedidos para processar em grupo, frequentemente a um preço reduzido.

GET /v1/batches

Lista os lotes em curso e concluídos.

Ferramentas integradas no servidor

O endpoint /v1/responses suporta ferramentas que a API executa diretamente, sem lógica do lado do cliente:

  • web_search: pesquisa na web em tempo real
  • x_search: pesquisa em publicações do X (Twitter)
  • code_interpreter: execução de código Python
  • function: chamadas de funções personalizadas (function calling)

Ativa estas ferramentas através do parâmetro tools do pedido.

Pontos-chave

  • A API abrange texto, imagens, vídeo, áudio e ficheiros
  • /v1/responses é o endpoint principal, com o suporte mais completo
  • O modo deferred permite o processamento assíncrono para pedidos longos
  • As ferramentas do lado do servidor (web_search, x_search, code_interpreter) enriquecem as respostas sem código adicional