Autenticación
La API de Venice usa API keys para la autenticación. Crea y gestiona tus API keys en tu configuración de API. Todas las solicitudes a la API requieren autenticación HTTP Bearer:Tu API key es un secreto. No la compartas ni la expongas en ningún código del lado del cliente.
Compatibilidad con OpenAI
La API de Venice implementa la especificación de la API de OpenAI, lo que garantiza compatibilidad con clientes y herramientas existentes de OpenAI. Esto te permite integrarte con Venice usando la conocida interfaz de OpenAI mientras accedes a las funciones únicas y los modelos sin censura de Venice.Configuración
Configura tu cliente para usar la URL base de Venice (https://api.venice.ai/api/v1) y realiza tu primera solicitud:
Funciones específicas de Venice
System prompts
Venice proporciona system prompts predeterminados diseñados para garantizar respuestas naturales y sin censura del modelo. Tienes dos opciones para gestionar los system prompts:- Comportamiento predeterminado: tus system prompts se añaden a los predeterminados de Venice
- Comportamiento personalizado: desactiva por completo los system prompts de Venice
Desactivar los system prompts de Venice
Usa la opciónvenice_parameters para eliminar los system prompts predeterminados de Venice:
Venice Parameters
El objetovenice_parameters te permite acceder a funciones específicas de Venice no disponibles en la API estándar de OpenAI:
Estos parámetros también se pueden especificar como sufijos de modelo añadidos al nombre del modelo (p. ej.,
zai-org-glm-5:enable_web_search=auto). Consulta Sufijos de características del modelo para más detalles.Prompt caching
Venice admite prompt caching en modelos seleccionados para reducir la latencia y los costes en contenido repetido. Para los modelos compatibles, Venice almacena automáticamente en caché los system prompts: no se requieren cambios de código. También puedes marcar manualmente contenido para caching usando la propiedadcache_control en el contenido del mensaje.
Consulta Prompt caching para detalles sobre cómo funciona el caching, la facturación y las mejores prácticas.
Referencia de cabeceras de respuesta
Todas las respuestas de la API de Venice incluyen cabeceras HTTP que proporcionan metadatos sobre la solicitud, los límites de velocidad, la información del modelo y el saldo de la cuenta. Además de los códigos de error devueltos por las respuestas de la API, puedes inspeccionar estas cabeceras para obtener el ID único de una solicitud concreta a la API, monitorizar los límites de velocidad y hacer seguimiento del saldo de tu cuenta. Venice recomienda registrar los IDs de solicitud (cabeceraCF-RAY) en despliegues de producción para una resolución de problemas más eficiente con nuestro equipo de soporte, si fuera necesario.
La tabla siguiente ofrece una referencia completa de todas las cabeceras que puedes encontrar:
Notas importantes
- Mayúsculas/minúsculas en nombres de cabeceras: las cabeceras HTTP no distinguen entre mayúsculas y minúsculas, pero Venice utiliza minúsculas con guiones para coherencia
- Valores de cadena: los valores booleanos en las cabeceras se devuelven como cadenas (
"true"o"false") - Valores numéricos: los números grandes y los valores de saldo pueden devolverse como cadenas para evitar pérdida de precisión
- Cabeceras opcionales: no todas las cabeceras se devuelven en cada respuesta; su presencia depende del endpoint y del contexto de la solicitud
- Compresión: utiliza
Accept-Encoding: gzip, bren las solicitudes para recibir respuestas comprimidas donde se admita
Ejemplo: acceder a las cabeceras de respuesta
Mejores prácticas
- Límites de velocidad: monitoriza las cabeceras
x-ratelimit-remaining-requestsyx-ratelimit-remaining-tokense implementa backoff exponencial - Monitorización del saldo: rastrea las cabeceras
x-venice-balance-usdyx-venice-balance-diempara evitar interrupciones del servicio - System prompts: prueba con y sin los system prompts de Venice para encontrar el mejor ajuste para tu caso de uso
- API keys: mantén tus API keys seguras y rótalas regularmente
- Registro de solicitudes: registra los valores de la cabecera
CF-RAYpara la resolución de problemas con soporte - Deprecación de modelos: comprueba las cabeceras
x-venice-model-deprecation-warningal usar modelos
Diferencias con la API de OpenAI
Aunque Venice mantiene una alta compatibilidad con la especificación de la API de OpenAI, hay algunas diferencias clave:- venice_parameters: configuraciones adicionales como
enable_web_search,character_slugystrip_thinking_responsepara funcionalidad ampliada - System prompts: Venice añade tus system prompts a los predeterminados que optimizan respuestas sin censura (desactívalo con
include_venice_system_prompt: false) - Ecosistema de modelos: Venice ofrece su propia línea de modelos incluyendo modelos sin censura y de razonamiento; usa los IDs de modelo de Venice en lugar de los mapeos de OpenAI
- Cabeceras de respuesta: cabeceras únicas para el seguimiento de saldo (
x-venice-balance-usd,x-venice-balance-diem), avisos de deprecación de modelos y flags de seguridad de contenido - Políticas de contenido: políticas más permisivas con modelos sin censura dedicados y filtrado de contenido opcional
Estabilidad de la API
Venice mantiene la compatibilidad hacia atrás para los endpoints y parámetros v1. Para la política del ciclo de vida de los modelos, avisos de deprecación y orientación de migración, consulta Deprecaciones.Especificación OpenAPI y datos en bruto
Para acceso programático a los documentos y datos de la API de Venice — incluido el uso con RAG (Retrieval-Augmented Generation) — están disponibles los siguientes recursos:- Especificación OpenAPI (YAML) — la especificación completa de la API en formato YAML
- Código fuente de los docs — todas las páginas de documentación (formato
.mdx) como archivo descargable
Los campos de solicitud no listados en esta documentación pueden ser aceptados pero no se validan ni se garantiza que funcionen.