Documentação

Documentação

Copilot para Obsidian

A guia BYOK do Copilot aceita um provedor personalizado compatível com OpenAI em três campos. A documentação é precisa sobre quais áreas recebem os modelos resultantes; esta página mantém essa precisão, sem prometer compatibilidade com o plugin inteiro.

Settings → Copilot → BYOK → Add a custom provider: um Display name, sua chave e https://api.kunavo.com/v1 — Quick Chat sempre disponível, Agent Chat em opencode quando o provedor aparece ali.

Settings → Copilot → BYOK → Add a provider → Add a custom provider
Display name             Kunavo
API key                  sk-kn-...
Base URL                 https://api.kunavo.com/v1
Enable CORS              off — see the note below before turning it on
Model ID → Add           claude-sonnet-5
                         claude-haiku-4-5
Search available models  discovery reads GET /v1/models; typed ids also work
Save                     needs at least one model and a routable endpoint
A URL base mantém o sufixo /v1 neste caso, e a documentação esclarece isso por meio de exemplos, não de uma frase: ela diz apenas que "Um provedor personalizado compatível com OpenAI precisa ter uma Base URL", mas os dois modelos compatíveis com OpenAI que ela inclui vêm, por padrão, com uma URL terminada em /v1 — http://localhost:11434/v1 para Ollama e http://localhost:1234/v1 para LM Studio — e acrescenta que "A descoberta de modelos usa a resposta /v1/models do endpoint". Se a descoberta não retornar nada, essa é a primeira combinação a conferir novamente.
Um provedor BYOK não está disponível em todas as áreas do plugin, e a documentação é explícita: "Adicionar uma chave não altera os modelos fornecidos pelo Claude Code ou pelo Codex." A tabela do próprio plugin disponibiliza os modelos BYOK diretamente no Quick Chat e no Agent Chat apenas com o backend opencode, "quando o provedor é exibido ali" — uma condição, não uma regra geral; além disso, "Um modelo que o opencode não consegue encaminhar fica de fora da lista do opencode, mas ainda pode funcionar no Quick Chat." Se você usar o backend Claude ou Codex, a configuração fica no ambiente da própria CLI: consulte /docs/integrations/claude-code.
Enable CORS é uma concessão, não algo para deixar ativado como solução permanente. A documentação diz: "Se o teste for bem-sucedido, mas o Quick Chat não conseguir enviar uma mensagem, edite o provedor e ative Enable CORS. As respostas aparecerão quando a geração for concluída, em vez de serem transmitidas token por token." Ela também observa que essa opção não altera o encaminhamento do opencode. Portanto, ativá-la para corrigir o Quick Chat faz com que você perca a saída token por token apenas nele, sem afetar nenhum outro lugar.
O Copilot 4.x não precisa de um provedor de embeddings: sua busca semântica migrou para o Miyo, um serviço separado, e a janela BYOK não tem esse campo — o que é bom, pois o Kunavo não oferece nenhum modelo de embeddings e esta página não dará a entender que oferece.
O Kunavo não testou este plugin em tempo de execução. Todos os campos e citações acima foram consultados na documentação do próprio Copilot na data abaixo; uma página de configuração publicada não é uma execução de teste. Envie uma tarefa real pelo Quick Chat antes de transferir seu fluxo de trabalho para ele.
Ainda não tem uma chave? Crie uma conta na Kunavo, gere uma chave (ela começa com sk-kn-) e adicione crédito a partir de $10 — as chamadas são pagas com esse saldo, e chamadas malsucedidas não são cobradas. O painel então abre na configuração de Copilot para Obsidian.

Passo a passo

  1. Crie uma chave em /app/keys e copie-a — ela é exibida uma única vez.
  2. No Obsidian, abra Settings → Copilot → BYOK e clique em Add a provider.
  3. Escolha Add a custom provider, em vez de um provedor com nome específico ou de um modelo Self Host.
  4. Preencha Display name, API key e Base URL conforme indicado acima. Por enquanto, deixe Enable CORS desativado.
  5. Adicione pelo menos um modelo — digite um id em Model ID → Add ou escolha um em Search available models, cujas opções são preenchidas com GET /v1/models. Clique em Test e depois em Save; o salvamento será bloqueado até que haja um modelo e um endpoint capaz de encaminhar as solicitações.
  6. Escolha onde esses modelos aparecem em Basic → Agents → Quick Chat e Basic → Agents → opencode, cada um com seu próprio Default model. Por padrão, os novos modelos de chat ficam ativados em ambos.

Verificado em Página Model Sources and BYOK do Copilot em 21 de setembro de 2026. As configurações de terceiros podem mudar; se o nome de um campo aqui já não corresponder ao que você vê, aquela página é a autoridade, não esta.

Esta é a versão resumida. O guia completo — escolha do modelo, custo de uma sessão real e modos de falha — está em qual backend do Copilot realmente paga pelos tokens.

Verifique antes de depurar o cliente

Uma solicitação determina se a falha está no endpoint, na chave ou no arquivo de configuração. Se isto retornar JSON, a mesma URL base e a mesma chave funcionarão em Copilot para Obsidian.

# Settles whether a failure is the endpoint, the key, or the client.
curl -sS https://api.kunavo.com/v1/models \
  -H "Authorization: Bearer sk-kn-..."

Qual ID de modelo inserir no campo

Todo modelo de texto pode ser acessado como um ID de modelo — a lista atual está em GET /v1/models, e o catálogo com preços está na página de modelos. As tarifas são em USD por 1 milhão de tokens, entrada / saída.

ID do modeloEntrada / saída da KunavoOnde se encaixa em Copilot para Obsidian
claude-haiku-4-5$0.70 / $3.50Quick Chat, onde as perguntas curtas sobre uma nota são feitas o dia inteiro
claude-sonnet-5$1.40 / $7.00o backend opencode no Agent Chat — o modelo de trabalho padrão
claude-opus-5$3.50 / $17.50síntese de longo alcance entre muitas notas, em que uma interpretação equivocada custa caro
gpt-5-6-sol$2.00 / $12.00uma segunda opinião de outra família, com a mesma chave e o mesmo provedor
A cobrança é por token, usando um saldo pré-pago e sem tarifa mensal — consulte billing. Em contextos repetidos — que representam a maior parte do que um editor ou cliente de chat envia — o cache de prompt altera a conta mais do que a escolha do modelo.

Perguntas frequentes

Onde adiciono uma chave de API no Obsidian Copilot?

Settings → Copilot → BYOK → Add a provider e, em seguida, "Add a custom provider" para um endpoint que não esteja na lista integrada. A janela pede um Display name, a chave de API, uma Base URL, uma opção Enable CORS e pelo menos um modelo, adicionado pelo id ou escolhido na lista descoberta; depois, clique em Save. A documentação do Copilot informa que as chaves dos provedores são armazenadas no Keychain do Obsidian daquele dispositivo, e não no data.json do cofre. Portanto, sincronizar um cofre não transfere a credencial para outro computador.

A URL base do Obsidian Copilot precisa terminar com /v1?

Use a forma com /v1 — https://api.kunavo.com/v1 para o Kunavo. A documentação não declara a regra em uma frase; ela informa que um provedor personalizado compatível com OpenAI precisa ter uma Base URL, que a descoberta de modelos usa a resposta /v1/models do endpoint e que os dois modelos compatíveis com OpenAI incluídos vêm, por padrão, com http://localhost:11434/v1 e http://localhost:1234/v1. Ambos os padrões fornecidos incluem o sufixo, e esse é o indício mais forte nos documentos. Uma URL base incorreta geralmente resulta em uma lista de modelos vazia ou em uma falha no Test, e não em um erro de autenticação.

O Obsidian Copilot pode usar um gateway como OpenRouter ou Kunavo em vez de uma chave de fornecedor?

Sim para o Quick Chat e, condicionalmente, para o Agent Chat. A documentação do próprio Copilot descreve o BYOK como uma forma de se conectar "diretamente a um provedor de IA, gateway compatível ou servidor de modelos no seu computador", e a opção "Add a custom provider" aceita qualquer URL base compatível com OpenAI e um id de modelo. Em seguida, a tabela de fontes de modelos disponibiliza os modelos BYOK diretamente no Quick Chat e no Agent Chat apenas com o backend opencode, "quando o provedor é exibido ali". Os backends Claude e Codex não aceitam uma chave BYOK — a documentação diz que adicionar uma chave não altera os modelos que eles fornecem.

Preciso de um modelo de embeddings para a busca no cofre do Obsidian Copilot?

Não do seu provedor de chat. O Copilot 4.x não mantém mais seu próprio índice dentro do plugin: a documentação informa que a busca semântica e as Notas relevantes são fornecidas pelo Miyo, um serviço local ou remoto separado, e a janela BYOK não tem um campo para esse tipo de modelo. O Kunavo também não oferece modelos de embeddings, portanto nada aqui deve ser entendido como oferta desse recurso — uma linha de provedor de chat no Copilot paga apenas pelo chat.

Uma chave Kunavo substitui uma licença Copilot Lite ou Plus?

Não, e os dois são itens separados de propósito. A documentação do Copilot trata a licença e o BYOK como fontes de modelos diferentes: a licença fornece modelos hospedados pelo Copilot, cobrados pela Brevilabs conforme seu plano, enquanto o BYOK envia solicitações ao seu próprio endpoint, e a cobrança fica a cargo desse provedor. Uma chave daqui não recarrega a franquia da licença, não desbloqueia os modelos hospedados pelo Copilot que estão bloqueados nem altera os serviços condicionados à licença; por outro lado, você pode usar BYOK no plano gratuito sem licença alguma.