Use o OpenCode com a CometAPI

Use este guia para executar o OpenCode com a CometAPI. A configuração expõe quatro formatos de API por meio de provedores personalizados separados. Esta configuração foi testada com o OpenCode 1.18.16. Referências oficiais:

Substitua cada valor your-model-id por um ID de modelo da página de modelos da CometAPI. Escolha um modelo que aceite o formato de API da entrada de provedor ao redor.

Pré-requisitos

Node.js e npm, ou outro método de instalação do guia do OpenCode
Uma conta da CometAPI com uma chave de API ativa do painel
Um ou mais IDs de modelo da página de modelos da CometAPI

Entenda os formatos de API

Cada ID de provedor seleciona um adaptador de SDK e um formato de API.

ID do provedor	Adaptador do OpenCode	URL base	Formato de API
`cometapi-chat`	`@ai-sdk/openai-compatible`	`https://api.cometapi.com/v1`	Chat Completions
`cometapi-responses`	`@ai-sdk/openai`	`https://api.cometapi.com/v1`	Responses
`cometapi-messages`	`@ai-sdk/anthropic`	`https://api.cometapi.com/v1`	Anthropic Messages
`cometapi-gemini`	`@ai-sdk/google`	`https://api.cometapi.com/v1beta`	Gemini generateContent

Este guia verifica a operação de Streaming do Gemini usada durante um turno normal do agente do OpenCode. O adaptador do Google acrescenta :streamGenerateContent?alt=sse ao caminho do modelo. Não adicione /chat/completions, /responses, /messages, nem um caminho de modelo do Gemini a baseURL. Cada adaptador acrescenta o caminho de operação necessário.

Entenda as permissões em tempo de execução

O OpenCode é executado com as permissões do processo que o inicia. Inicie o OpenCode no diretório de projeto pretendido e mantenha um caminho de reversão, como git. Use um contêiner ou sandbox quando precisar de limites mais rigorosos para sistema de arquivos, processos, rede ou chaves de API.

Configurar o OpenCode

Instalar o OpenCode

Instale o OpenCode usando o pacote oficial do npm:

npm install -g opencode-ai

Confirme que a CLI está disponível:

opencode --version

Consulte o guia de instalação do OpenCode para Homebrew, Windows, Docker e outros métodos de instalação.

Definir sua chave de API da CometAPI

Armazene sua chave de API da CometAPI na variável de ambiente COMETAPI_KEY.

macOS / Linux / WSL
Windows PowerShell

Leia a chave de API sem exibi-la no terminal:

read -rsp "CometAPI API key: " COMETAPI_KEY
printf '\n'
export COMETAPI_KEY

Leia a chave de API na sessão atual do PowerShell:

$secureKey = Read-Host "CometAPI API key" -AsSecureString
$env:COMETAPI_KEY = [System.Net.NetworkCredential]::new(
  "",
  $secureKey
).Password

Defina a variável em todas as sessões do shell que iniciam o OpenCode. Não faça commit de chaves de API no controle de versão.

Escolher um local de configuração

Use um destes locais compatíveis:

Configuração global: ~/.config/opencode/opencode.json
Configuração do projeto: opencode.json na raiz do projeto

O OpenCode mescla os arquivos de configuração. Uma configuração do projeto substitui valores conflitantes da configuração global.Use o arquivo global quando quiser os provedores em todos os projetos. Use o arquivo do projeto quando um repositório precisar de suas próprias entradas de modelo.

Adicionar os provedores da CometAPI

Crie o arquivo de configuração selecionado. Se o arquivo já contiver um provider objeto, mescle estas quatro entradas nesse objeto:

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "cometapi-chat": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "CometAPI Chat Completions",
      "options": {
        "baseURL": "https://api.cometapi.com/v1",
        "apiKey": "{env:COMETAPI_KEY}"
      },
      "models": {
        "your-model-id": {
          "name": "CometAPI Chat model"
        }
      }
    },
    "cometapi-responses": {
      "npm": "@ai-sdk/openai",
      "name": "CometAPI Responses",
      "options": {
        "baseURL": "https://api.cometapi.com/v1",
        "apiKey": "{env:COMETAPI_KEY}"
      },
      "models": {
        "your-model-id": {
          "name": "CometAPI Responses model"
        }
      }
    },
    "cometapi-messages": {
      "npm": "@ai-sdk/anthropic",
      "name": "CometAPI Anthropic Messages",
      "options": {
        "baseURL": "https://api.cometapi.com/v1",
        "apiKey": "{env:COMETAPI_KEY}"
      },
      "models": {
        "your-model-id": {
          "name": "CometAPI Messages model"
        }
      }
    },
    "cometapi-gemini": {
      "npm": "@ai-sdk/google",
      "name": "CometAPI Gemini",
      "options": {
        "baseURL": "https://api.cometapi.com/v1beta",
        "apiKey": "{env:COMETAPI_KEY}"
      },
      "models": {
        "your-model-id": {
          "name": "CometAPI Gemini model"
        }
      }
    }
  }
}

Substitua cada chave your-model-id individualmente. As quatro entradas podem usar IDs de modelo diferentes.A configuração não define um model de nível superior. Isso permite escolher o formato de API necessário e o modelo por meio de /models.

Não use /connect para esta configuração. Os campos apiKey leem COMETAPI_KEY do ambiente. Uma variável não definida é resolvida como um valor vazio em vez de uma chave de API /connect armazenada.

Selecionar e verificar cada provedor

Inicie o OpenCode no projeto ao qual você quer que ele tenha acesso:

opencode

Execute /models e selecione uma entrada provider/model. Nas quatro verificações realizadas para este guia, cada rodada do modelo usou o formato de API correspondente à entrada selecionada. Não foi observada nenhuma distribuição de solicitações entre formatos nem negociação automática do formato de API .Para verificar Chat Completions na linha de comando, execute:

opencode run \
  --model cometapi-chat/your-model-id \
  "Reply exactly with: COMETAPI_CHAT_OK"

Para verificar Responses na linha de comando, execute:

opencode run \
  --model cometapi-responses/your-model-id \
  "Reply exactly with: COMETAPI_RESPONSES_OK"

Para verificar Anthropic Messages na linha de comando, execute:

opencode run \
  --model cometapi-messages/your-model-id \
  "Reply exactly with: COMETAPI_MESSAGES_OK"

Para verificar Gemini generateContent na linha de comando, execute:

opencode run \
  --model cometapi-gemini/your-model-id \
  "Reply exactly with: COMETAPI_GEMINI_OK"

Solução de problemas

O OpenCode não exibe um modelo da CometAPI

Confirme se a configuração é um JSON válido. Cada entrada personalizada deve estar dentro do objeto provider de nível superior, e cada ID de modelo deve estar dentro do objeto models correspondente. Reinicie o OpenCode e abra /models novamente.

O OpenCode informa um erro de chave de API ou autenticação

Confirme se COMETAPI_KEY está definido no shell que inicia o OpenCode. Uma referência {env:COMETAPI_KEY} não definida se torna um valor vazio. Abra um novo shell depois de alterar um perfil de shell.

Um ID de modelo está indisponível

Confira a página CometAPI Models, depois substitua o modelo ID dentro da entrada do provedor selecionado. Confirme se o modelo aceita esse formato de API do provedor.

As solicitações usam um caminho incorreto

Mantenha baseURL em /v1 para Chat Completions, Responses e Messages. Use /v1beta para Gemini. Não inclua um caminho de operação em baseURL.

Um provedor funciona, mas outro falha

Use um ID de modelo que aceite o formato de API do provedor selecionado. Não presuma que um ID de modelo aceite os quatro formatos.

A configuração do projeto altera um provedor global

O OpenCode mescla a configuração global e a do projeto. Renomeie o ID do provedor do projeto ou remova os valores conflitantes quando quiser que a entrada do provedor global permaneça inalterada.

O OpenCode tem mais acesso do que o esperado

O OpenCode usa as permissões do processo que o iniciou. Execute o OpenCode em um contêiner ou sandbox quando precisar de limites de acesso mais rigorosos.

Visão Geral

Agentes de programação de IA

Agentes de IA

Clientes de chat de IA

Tradução e idioma

Plataformas de automação

Observabilidade e avaliação

Frameworks de IA

Pré-requisitos

Entenda os formatos de API

Entenda as permissões em tempo de execução

Configurar o OpenCode

Solução de problemas

Recursos relacionados

​Pré-requisitos

​Entenda os formatos de API

​Entenda as permissões em tempo de execução

​Configurar o OpenCode

​Solução de problemas

​Recursos relacionados

Pré-requisitos

Entenda os formatos de API

Entenda as permissões em tempo de execução

Configurar o OpenCode

Solução de problemas

Recursos relacionados