Autenticação
A API Venice usa chaves de API para autenticação. Crie e gerencie suas chaves de API em suas configurações de API. Todas as requisições da API exigem autenticação Bearer HTTP:Sua chave de API é um segredo. Não a compartilhe nem a exponha em qualquer código do lado do cliente.
Compatibilidade com OpenAI
A API da Venice implementa a especificação da API OpenAI, garantindo compatibilidade com clientes e ferramentas existentes do OpenAI. Isso permite que você integre com a Venice usando a familiar interface OpenAI ao mesmo tempo em que acessa os recursos exclusivos da Venice e os modelos sem censura.Configuração
Configure seu cliente para usar a URL base da Venice (https://api.venice.ai/api/v1) e faça sua primeira requisição:
Recursos específicos da Venice
Prompts de sistema
A Venice fornece prompts de sistema padrão projetados para garantir respostas de modelos sem censura e naturais. Você tem duas opções para lidar com prompts de sistema:- Comportamento padrão: Seus prompts de sistema são acrescentados aos padrões da Venice
- Comportamento personalizado: Desabilite completamente os prompts de sistema da Venice
Desabilitando os prompts de sistema da Venice
Use a opçãovenice_parameters para remover os prompts de sistema padrão da Venice:
Parâmetros da Venice
O objetovenice_parameters permite acessar recursos específicos da Venice que não estão disponíveis na API OpenAI padrão:
Esses parâmetros também podem ser especificados como sufixos de modelo anexados ao nome do modelo (por exemplo,
zai-org-glm-5:enable_web_search=auto). Veja Sufixos de recursos do modelo para detalhes.Prompt caching
A Venice oferece suporte a prompt caching em modelos selecionados para reduzir latência e custos para conteúdo repetido. Para modelos compatíveis, a Venice armazena automaticamente em cache prompts de sistema — sem necessidade de alterações no código. Você também pode marcar manualmente conteúdo para cache usando a propriedadecache_control no conteúdo da mensagem.
Veja Prompt caching para detalhes sobre como o caching funciona, cobrança e melhores práticas.
Referência de cabeçalhos de resposta
Todas as respostas da API Venice incluem cabeçalhos HTTP que fornecem metadados sobre a requisição, limites de taxa, informações do modelo e saldo da conta. Além dos códigos de erro retornados das respostas da API, você pode inspecionar esses cabeçalhos para obter o ID único de uma requisição específica da API, monitorar limites de taxa e acompanhar o saldo da sua conta. A Venice recomenda registrar IDs de requisição (cabeçalhoCF-RAY) em implantações de produção para uma solução de problemas mais eficiente com nossa equipe de suporte, caso seja necessário.
A tabela abaixo fornece uma referência abrangente de todos os cabeçalhos que você pode encontrar:
Notas importantes
- Capitalização do nome do cabeçalho: Os cabeçalhos HTTP são case-insensitive, mas a Venice usa minúsculas com hífens para consistência
- Valores em string: Valores booleanos em cabeçalhos são retornados como strings (
"true"ou"false") - Valores numéricos: Números grandes e valores de saldo podem ser retornados como strings para evitar perda de precisão
- Cabeçalhos opcionais: Nem todos os cabeçalhos são retornados em todas as respostas; a presença depende do endpoint e do contexto da requisição
- Compactação: Use
Accept-Encoding: gzip, brnas requisições para receber respostas compactadas quando suportado
Exemplo: Acessando cabeçalhos de resposta
Melhores práticas
- Limite de taxa: Monitore os cabeçalhos
x-ratelimit-remaining-requestsex-ratelimit-remaining-tokense implemente backoff exponencial - Monitoramento de saldo: Acompanhe os cabeçalhos
x-venice-balance-usdex-venice-balance-diempara evitar interrupções de serviço - Prompts de sistema: Teste com e sem os prompts de sistema da Venice para encontrar o melhor ajuste para seu caso de uso
- Chaves de API: Mantenha suas chaves de API seguras e faça rotação regularmente
- Registro de requisições: Registre os valores do cabeçalho
CF-RAYpara solucionar problemas com o suporte - Descontinuação de modelos: Verifique os cabeçalhos
x-venice-model-deprecation-warningao usar modelos
Diferenças em relação à API da OpenAI
Embora a Venice mantenha alta compatibilidade com a especificação da API OpenAI, há algumas diferenças importantes:- venice_parameters: Configurações adicionais como
enable_web_search,character_slugestrip_thinking_responsepara funcionalidade estendida - Prompts de sistema: A Venice acrescenta seus prompts de sistema a padrões otimizados para respostas sem censura (desabilite com
include_venice_system_prompt: false) - Ecossistema de modelos: A Venice oferece sua própria linha de modelos incluindo modelos sem censura e de raciocínio — use os IDs de modelo da Venice em vez dos mapeamentos da OpenAI
- Cabeçalhos de resposta: Cabeçalhos exclusivos para rastreamento de saldo (
x-venice-balance-usd,x-venice-balance-diem), avisos de descontinuação de modelos e flags de segurança de conteúdo - Políticas de conteúdo: Políticas mais permissivas com modelos dedicados sem censura e filtragem de conteúdo opcional
Estabilidade da API
A Venice mantém compatibilidade retroativa para endpoints e parâmetros v1. Para política de ciclo de vida de modelos, avisos de descontinuação e orientações de migração, veja Descontinuações.Especificação OpenAPI e dados brutos
Para acesso programático à documentação e aos dados da API Venice — incluindo uso com RAG (Retrieval-Augmented Generation) — os seguintes recursos estão disponíveis:- Especificação OpenAPI (YAML) — a especificação completa da API em formato YAML
- Fonte da documentação da API — todas as páginas de documentação (formato
.mdx) como um arquivo para download
Campos de requisição não listados nesta documentação podem ser passados, mas não são validados nem garantidos para funcionar.