Clientes/Z Code

Use a API da Wokey com o Z Code

Obtenha uma chave de API da Wokey, aponte o Z Code para a base URL da Wokey e confirme a conexão com uma requisição curl.

Atualizado

Nesta páginaexpand_more

Obtenha uma chave de API e a base URLlink

Todos os clientes usam a mesma chave de API da Wokey e a mesma base URL.

Crie uma chave de API

Entre e crie uma chave da plataforma na página API. As chaves de uma mesma conta compartilham o saldo dela.

Criar chave de APIkey

Use a base URL da Wokey

Defina como base URL do cliente o domínio do gateway; a configuração abaixo mostra se é preciso acrescentar /v1.

Configure o clientelink

O Z Code adiciona providers personalizados na página de configurações e suporta os formatos de API da Anthropic e da OpenAI. Use o formato da Anthropic para os modelos Claude.

  1. 1

    Abra as configurações de modelo

    Clique no nome do modelo na caixa de chat → Manage Models, ou vá em Settings → Model Settings.

  2. 2

    Adicione o provider

    Clique em Add Provider e dê o nome Wokey. Para o formato da Anthropic, defina Base URL como https://api.wokey.ai; para o formato da OpenAI, como https://api.wokey.ai/v1. Cole sua chave de API da Wokey em API Key.

  3. 3

    Adicione e ative um modelo

    Sob o provider, clique em Add Model, informe um ID de modelo como claude-opus-5-5 e ative a chave de ativação dele.

  4. 4

    Troque de modelo

    De volta à caixa de chat, escolha o modelo que você adicionou na lista de modelos e envie uma mensagem curta para confirmar.

Z Code
Provider name: Wokey
API format: Anthropic
Base URL: https://api.wokey.ai
API Key: YOUR_API_KEY
Model ID: claude-opus-5-5

Formatos de API e base URLslink

Quando um mesmo cliente troca de formato de API, pode mudar se a base URL termina em /v1.

FormatoBase URLUse para
Anthropic Messageshttps://api.wokey.aiModelos Claude
OpenAI Chat Completionshttps://api.wokey.ai/v1DeepSeek, GLM, Kimi e outros modelos

Onde é configurado: Settings → Model Settings (arquivo ~/.zcode/v2/config.json)

Verifique com curllink

Se o cliente mostrar um erro, primeiro descarte problemas com a chave e a base URL usando curl.

Z Code usa o formato Anthropic Messages por padrão. Se esta requisição retornar 200, a chave e a base URL estão corretas. Substitua YOUR_API_KEY pela sua chave antes de enviar.

cURL
curl https://api.wokey.ai/v1/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-5",
    "max_tokens": 1024,
    "messages": [
      { "role": "user", "content": "Hello" }
    ]
  }'

Erros e solução de problemaslink

Primeiro separe os casos de autenticação, saldo, limite de taxa, disponibilidade do modelo e tempo limite do upstream.

401

invalid api key

A chave está ausente, foi digitada errado, foi excluída, ou os cabeçalhos Authorization / x-api-key são conflitantes.

402

insufficient balance

O saldo da conta está baixo demais. Recarregue antes de enviar mais requisições.

403

model_denylisted / account_restricted

As chamadas ao modelo, ou a todos os modelos da conta, estão pausadas após violações repetidas. Veja Taxas de tratamento de violação e restrições.

403

request_blocked

Esta requisição foi bloqueada antes de chegar ao upstream e não é cobrada, por exemplo o reenvio sem alterações de uma requisição que o modelo acabou de recusar, ou um usuário final pausado (X-End-User-Id). A mensagem de erro diz o que está bloqueado; altere a requisição conforme indicado ou tente de novo mais tarde. As outras requisições não são afetadas.

429

rate limited

O tráfego está frequente demais. Tente de novo mais tarde ou reduza a concorrência. Se só um modelo, ou um usuário final (X-End-User-Id), continua retornando 429, pode ser um limite temporário após violações.

499

client disconnected

O cliente fechou a conexão antes de a resposta terminar (código downstream_aborted). Por padrão isso é gratuito. Quando uma conta tem pelo menos 50 desconexões do cliente nas últimas 24 horas e elas representam 10% ou mais das suas requisições, as requisições desconectadas seguintes são cobradas pelo uso que o upstream informou: a entrada processada, incluindo leituras e gravações de cache, e a saída apenas quando o upstream a contabilizou. Uma desconexão antes de o upstream informar qualquer uso continua gratuita. A conta é avisada quando a cobrança começa, e a cobrança para automaticamente em até uma hora quando a taxa de desconexão volta ao normal. A causa comum é um tempo limite do cliente ou do proxy curto demais, ou um programa que cancela requisições antes de terminarem.

502

upstream unavailable

O serviço do modelo upstream está temporariamente indisponível. Troque de modelo ou tente de novo mais tarde.

504

upstream timeout

A resposta do upstream excedeu o tempo limite. Encurte o contexto, reduza max_tokens ou tente de novo.

529

upstream overloaded

O modelo upstream está temporariamente sobrecarregado e a Wokey já tentou de novo por outras rotas (código upstream_overloaded). Não tem relação com o seu saldo. Tente de novo em instantes ou troque de modelo.

Perguntas frequenteslink

A URL base do Z Code deve terminar em /v1?
Depende do formato de API com que você se conecta. Para Anthropic use https://api.wokey.ai sem /v1; para OpenAI use https://api.wokey.ai/v1.
Por que as variáveis de ambiente que exportei no terminal são ignoradas?
As variáveis de ambiente do terminal e a configuração de modelos do app desktop do Z Code são separadas e não são sincronizadas. Informe a URL base e a chave de API no provider em Settings → Model Settings.
O provider foi adicionado. Por que não consigo escolher um modelo?
Cada provider também precisa de Add Model com um ID de modelo, e da chave de ativação do modelo ligada, antes que ele apareça na lista de modelos da caixa de chat.
E se a saída for cortada ou o contexto for pequeno demais?
Abra Advanced no modelo e ajuste Max output tokens e a janela de contexto para os valores da página do modelo. Um modelo recém-adicionado tem janela de contexto padrão de 200000.
Onde o Z Code armazena esta configuração?
Em ~/.zcode/v2/config.json. Faça backup do arquivo antes de trocar de máquina ou reinstalar; ele contém sua chave de API, então não o compartilhe.