Autenticazione
L’API Venice utilizza API key per l’autenticazione. Crea e gestisci le tue API key nelle tue impostazioni API. Tutte le richieste API richiedono l’autenticazione HTTP Bearer:La tua API key è un segreto. Non condividerla né esporla in alcun codice lato client.
Compatibilità con OpenAI
L’API di Venice implementa la specifica dell’API OpenAI, garantendo la compatibilità con client e strumenti OpenAI esistenti. Questo ti permette di integrarti con Venice usando la familiare interfaccia OpenAI accedendo al contempo alle funzionalità uniche e ai modelli senza restrizioni di Venice.Setup
Configura il tuo client per usare il base URL di Venice (https://api.venice.ai/api/v1) e fai la tua prima richiesta:
Funzionalità specifiche di Venice
System prompt
Venice fornisce system prompt predefiniti progettati per garantire risposte naturali e senza restrizioni del modello. Hai due opzioni per gestire i system prompt:- Comportamento predefinito: i tuoi system prompt vengono aggiunti a quelli di default di Venice
- Comportamento personalizzato: disabilita completamente i system prompt di Venice
Disabilitare i system prompt di Venice
Usa l’opzionevenice_parameters per rimuovere i system prompt predefiniti di Venice:
Venice Parameters
L’oggettovenice_parameters ti permette di accedere a funzionalità specifiche di Venice non disponibili nell’API OpenAI standard:
Questi parametri possono anche essere specificati come suffissi del modello aggiunti al nome del modello (es.
zai-org-glm-5:enable_web_search=auto). Consulta Model Feature Suffixes per i dettagli.Prompt caching
Venice supporta il prompt caching su modelli selezionati per ridurre latenza e costi per contenuti ripetuti. Per i modelli supportati, Venice memorizza automaticamente in cache i system prompt — non sono necessarie modifiche al codice. Puoi anche contrassegnare manualmente il contenuto per il caching usando la proprietàcache_control sul contenuto del messaggio.
Consulta Prompt caching per i dettagli su come funziona il caching, la fatturazione e le best practice.
Riferimento degli header di risposta
Tutte le risposte dell’API Venice includono header HTTP che forniscono metadati sulla richiesta, rate limit, informazioni sul modello e saldo dell’account. Oltre ai codici di errore restituiti dalle risposte API, puoi ispezionare questi header per ottenere l’ID univoco di una particolare richiesta API, monitorare il rate limiting e tracciare il saldo del tuo account. Venice consiglia di registrare gli ID delle richieste (headerCF-RAY) nei deployment in produzione per un troubleshooting più efficiente con il nostro team di supporto, in caso di necessità.
La tabella seguente fornisce un riferimento completo di tutti gli header che puoi incontrare:
Note importanti
- Maiuscole/minuscole nei nomi degli header: gli header HTTP sono case-insensitive, ma Venice usa minuscole con trattini per coerenza
- Valori stringa: i valori booleani negli header vengono restituiti come stringhe (
"true"o"false") - Valori numerici: numeri grandi e valori di saldo possono essere restituiti come stringhe per prevenire perdita di precisione
- Header opzionali: non tutti gli header vengono restituiti in ogni risposta; la presenza dipende dall’endpoint e dal contesto della richiesta
- Compressione: usa
Accept-Encoding: gzip, brnelle richieste per ricevere risposte compresse dove supportato
Esempio: accedere agli header di risposta
Best practice
- Rate limiting: monitora gli header
x-ratelimit-remaining-requestsex-ratelimit-remaining-tokense implementa un backoff esponenziale - Monitoraggio del saldo: traccia gli header
x-venice-balance-usdex-venice-balance-diemper evitare interruzioni del servizio - System prompt: testa con e senza i system prompt di Venice per trovare la soluzione migliore per il tuo caso d’uso
- API key: mantieni le tue API key al sicuro e ruotale regolarmente
- Logging delle richieste: registra i valori dell’header
CF-RAYper il troubleshooting con il supporto - Deprecazione dei modelli: controlla gli header
x-venice-model-deprecation-warningquando usi i modelli
Differenze rispetto all’API di OpenAI
Sebbene Venice mantenga un’elevata compatibilità con la specifica dell’API OpenAI, ci sono alcune differenze chiave:- venice_parameters: configurazioni aggiuntive come
enable_web_search,character_slugestrip_thinking_responseper funzionalità estese - System prompt: Venice aggiunge i tuoi system prompt ai default che ottimizzano per risposte senza restrizioni (disabilita con
include_venice_system_prompt: false) - Ecosistema dei modelli: Venice offre la propria lineup di modelli inclusi modelli senza restrizioni e di ragionamento - usa gli ID dei modelli Venice anziché le mappature OpenAI
- Header di risposta: header unici per il tracking del saldo (
x-venice-balance-usd,x-venice-balance-diem), avvisi di deprecazione dei modelli e flag di sicurezza del contenuto - Content policy: policy più permissive con modelli dedicati senza restrizioni e filtraggio dei contenuti opzionale
Stabilità dell’API
Venice mantiene la retrocompatibilità per gli endpoint e i parametri v1. Per la policy del ciclo di vita dei modelli, gli avvisi di deprecazione e le indicazioni di migrazione, consulta Deprecations.Specifica OpenAPI e dati raw
Per accesso programmatico ai doc e ai dati dell’API Venice — incluso l’uso con RAG (Retrieval-Augmented Generation) — sono disponibili le seguenti risorse:- Spec OpenAPI (YAML) — la specifica API completa in formato YAML
- Sorgente dei doc API — tutte le pagine di documentazione (formato
.mdx) come archivio scaricabile
I campi della richiesta non elencati in questa documentazione possono essere passati attraverso ma non sono validati né garantiti per funzionare.