Documentação da API

Checagem de liveness. Única rota que não vive sob /v1.

{ status: "ok", version: "0.1.0" }

Retorna a configuração atual do adapter: quais runtimes estão habilitados.

{
  claude: { enabled: boolean },
  codex: { enabled: boolean },
  opencode: { enabled: boolean },
}

Habilita/desabilita um ou mais runtimes de uma vez. Persistido em data/config.json.

Lista os runtimes habilitados e os modelos que cada um relata como disponível (consulta ao vivo via listModels() de cada runtime).

{
  agents: [
    { runtime: "claude" | "codex" | "opencode",
      models: [{ id: string, displayName: string, description?: string }] }
  ]
}

Um runtime cuja consulta de modelos falhar é simplesmente omitido da lista (o erro é apenas logado).

Cria um registro de sessão. Não inicia o agente, isso só acontece ao enviar a primeira mensagem.

Lista sessões conhecidas, com filtro por status e paginação.

{ sessions: AgentSession[], total: number, limit: number, offset: number }

Consulta o estado atual de uma sessão (status, providerSessionId, configurações, uso, etc).

Renomeia a sessão, alterando apenas o título exibido.

Remove o registro local da sessão e, quando o runtime suporta, também a conversa do lado do provedor (Claude e OpenCode; Codex não tem equivalente na SDK).

{ deleted: true }

409 se a sessão estiver running ou waiting_permission.

Histórico de mensagens da conversa, normalizado para o formato AgentEvent. A fonte varia por runtime: log local do Codex, API nativa do OpenCode, ou getSessionMessages da Claude Agent SDK.

{ events: AgentEvent[] }

404 se a sessão nunca chegou a trocar mensagens com o agente.

Uso acumulado de tokens/custo da sessão. Formato depende do runtime, veja Modelos de dados.

Ramifica a conversa em uma nova sessão independente, sem afetar a original.

somente claude / opencode Codex não tem operação de fork na SDK. 409 se a sessão ainda não tem conversa (sem providerSessionId).

Define ou limpa uma tag livre na sessão.

Para sessões Claude com conversa já iniciada, a tag também é espelhada do lado do provedor.

Envia uma mensagem ao agente. A execução roda em background; a resposta HTTP volta imediatamente e o progresso é acompanhado via SSE. Limite de corpo de 32 MB (por causa dos anexos em base64).

{ accepted: true }

Tipos de mídia aceitos: imagem jpeg, png, gif, webp; documento pdf, text/plain. Codex só aceita anexos de imagem; OpenCode ainda não suporta anexos. 409 se a sessão já estiver running ou waiting_permission.

Conexão Server-Sent Events com os eventos ao vivo da execução da sessão. Cada evento chega como event: <type> seguido de data: <AgentEvent em JSON>. A conexão fica aberta até o cliente desconectar.

Cancela a execução em andamento. Apenas sinaliza o cancelamento; o evento agent.cancelled confirma quando de fato parar.

{ cancelled: true }

409 se a sessão não estiver running.

Define o modo de permissão da sessão, usado como padrão nas próximas execuções.

{ mode, applied: "live" | "pending" }

applied: "live" quando a sessão já está em execução e o Claude consegue aplicar na hora. Para o OpenCode só default (agent "build") e plan (agent "plan") são aceitos. não aplicável ao Codex

Define o modelo da sessão. null reseta pro padrão da CLI.

{ model, applied: "live" | "pending" }

Aplicação ao vivo ("live") só existe hoje para sessões Claude em execução.

Reverte as edições de arquivo feitas a partir de uma mensagem de usuário específica.

{ canRewind: boolean, filesChanged?: number,
  insertions?: number, deletions?: number, error?: string }

somente claude / opencode Codex não tem sistema de rewind. 409 se a sessão ainda não tem conversa pra reverter.

Aprova um pedido de permissão de ferramenta pendente (evento permission.requested).

{ approved: true }

não aplicável ao Codex 404 se o pedido já tiver sido respondido ou nunca existiu.

Rejeita um pedido de permissão pendente.

{ rejected: true }

não aplicável ao Codex O OpenCode não aceita um motivo em texto livre; reason é aceito no corpo mas não é repassado ao servidor OpenCode.

Lista as tools que a Claude Code CLI reportou disponíveis para o projeto, a partir do cache por projectPath.

{ tools: string[] | null, updatedAt: string | null }

Configura a lista de tools que o Claude não pode usar nesta sessão.

{ deny: string[], applied: "pending" }

Configura o esforço de raciocínio do modelo Claude para esta sessão.

{ effort, applied: "pending" }

Configura o modo de sandbox/permissão de sistema de arquivos do Codex para esta sessão.

{ mode, applied: "pending" }

Configura o esforço de raciocínio do modelo Codex para esta sessão.

{ effort, applied: "pending" }

Habilita/configura a busca na web do Codex para esta sessão.

{ mode, enabled, applied: "pending" }

Concede ao Codex acesso a diretórios extras fora do projectPath da sessão.

{ directories: string[], applied: "pending" }

400 se algum caminho não for absoluto ou não existir como diretório.