Clientes/Codex

Use a API da Wokey com o Codex

Obtenha uma chave de API da Wokey, aponte o Codex 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 Codex CLI e o app de desktop do Codex compartilham a mesma configuração, então o passo a passo abaixo vale para os dois. O Codex usa o protocolo Responses. Mantenha base_url na origem do gateway, sem /responses. Substitua YOUR_API_KEY pela sua chave de API da Wokey em experimental_bearer_token, sem o prefixo Bearer. Remova qualquer configuração env_key existente; não é preciso exportar variável de ambiente. Salve o arquivo e execute codex. A chave fica salva em texto puro na configuração local.

Codex
# ~/.codex/config.toml
model = "gpt-6-sol"
model_provider = "wokey"

[model_providers.wokey]
name = "Wokey"
base_url = "https://api.wokey.ai"
experimental_bearer_token = "YOUR_API_KEY"
wire_api = "responses"

# shell
codex

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
OpenAI Responseshttps://api.wokey.aiModelos GPT

Onde é configurado: ~/.codex/config.toml

Verifique com curllink

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

Codex usa o formato OpenAI Responses 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/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-6-sol",
    "instructions": "You are a helpful assistant.",
    "input": [
      { "role": "user", "content": "Hello" }
    ],
    "store": false,
    "stream": false
  }'

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

O base_url do Codex deve terminar em /v1 ou /responses?
Em nenhum dos dois. Defina base_url como https://api.wokey.ai. O Codex acrescenta /responses por conta própria, então adicioná-lo à mão duplica o caminho.
O experimental_bearer_token precisa da palavra Bearer?
Não. Cole apenas a chave de API da Wokey e apague a linha env_key antiga para não precisar de nenhuma variável de ambiente.
O que vai em wire_api?
responses. O Codex usa o formato OpenAI Responses, que é como os modelos GPT são chamados na Wokey.

Guias de configuração e erroslink