Documentação

Como usar
a plataforma Shakk.

Documentação editorial de como integrar e operar o Shakk. Pra referência formal de cada endpoint — métodos, parâmetros, respostas — veja a API Reference.

Começar Autenticação API Shakk Code Ferramentas Exemplos API Reference Status

Começar

Toda conta Shakk é gratuita por padrão (plano Free) e serve pra tudo: o chat, o Shakk Code e o Console de desenvolvedor. Não existe cadastro separado pra cada um.

Duas formas de começar:

  • Usando o produto: abra o Shakk e entre com Google ou e-mail/senha.
  • Integrando por conta própria: entre no Console, crie uma chave de API e acompanhe a liberação dos endpoints públicos abaixo, em Status.

Autenticação

As interfaces autenticadas da plataforma usam a sessão da sua conta Fluqxo — a mesma usada no Shakk, com Google ou e-mail/senha. Para integrações externas, chaves de API (fluqxo_live_...) já podem ser criadas no Console.

O acesso programático por chave de API está em Early Access e será liberado progressivamente, ver Status.

API

A plataforma já possui APIs internas para essas capacidades — é o que hoje serve o próprio Shakk e o Shakk Code. O acesso programático público está sendo liberado progressivamente (ver Status); a lista completa de rotas, parâmetros e respostas fica na API Reference (Swagger).

Workspaces & conversas

Criação e gestão de workspaces, conversas e mensagens — a base do chat.

Chaves de API

Criação, listagem e revogação — segredo exibido uma única vez.

Plano & uso

Consulta de assinatura e consumo medido por workspace.

Shakk Code

O Shakk Code pareia com sua conta por um código de 6 dígitos, sem senha nem token de administrador circulando pelo CLI. O fluxo, em conceito:

gerar código → parear CLI → estabelecer sessão → executar

Depois do pareamento, site e CLI permanecem associados à mesma conta, com credenciais de acesso limitadas ao usuário — nenhuma credencial administrativa é armazenada no CLI. Esse pareamento é o protocolo interno do Shakk Code, não uma API pública de propósito geral; a integração programática externa é feita por chave de API (ver Autenticação).

Ferramentas

O Shakk usa formato de tool-calling compatível com OpenAI: o modelo decide quando chamar uma ferramenta, recebe o resultado de volta e continua a resposta com base nele.

Busca web

Resultado real (título, domínio, trecho) devolvido junto com a resposta.

Refino

Transforma um rascunho num prompt estruturado, pronto pra executar em qualquer IA.

Execução local (Shakk Code)

Ler/editar arquivo, buscar texto, rodar comando — sempre dentro da pasta de trabalho e do modo de trabalho escolhidos.

Exemplos

O que já dá pra fazer hoje, de ponta a ponta:

# 1. crie uma chave no Console (fluqxo.com.br/developers)
# 2. instale e pareie o Shakk Code
$ ./install.sh
$ shakk parear 123456
$ shakk agente

Exemplo de chamada de API direta (formato pretendido — endpoint em liberação progressiva, ver Status):

# ainda não disponível publicamente
curl -H "Authorization: Bearer fluqxo_live_..." \
  https://api.fluqxo.com.br/v1/chat

API Reference

A referência formal — todo endpoint, parâmetro e formato de resposta — é gerada diretamente da implementação (OpenAPI/Swagger), nunca copiada à mão aqui. É sempre a fonte mais atual.

Abrir API Reference (Swagger) ↗

Status

  • Ativo Autenticação, workspaces, conversas, mensagens, chaves de API, plano Free.
  • Ativo Busca web, Refino, pareamento e execução local do Shakk Code.
  • Early Access Respostas de IA no chat e no agente — em liberação junto com a infraestrutura de inferência.
  • Early Access Upload de arquivos — infraestrutura de armazenamento em ativação.
  • Em definição Planos pagos (checkout) e gateway público autenticado só por chave de API.