Documentazione API: Guida rapida

URL di base e autenticazione

L'API serverless llm utilizza la struttura standard degli endpoint compatibile con OpenAI. Per iniziare, hai bisogno di due informazioni: il tuo URL di base e la tua chiave API.

Utilizza il seguente URL di base per tutte le richieste:

https://api.serverlessllmapi.com/v1

L'autenticazione viene gestita tramite l'intestazione Authorization. Crea un account nella pagina Ottieni chiave API per ricevere la tua chiave. Puoi rigenerare questa chiave in qualsiasi momento, revocando istantaneamente quella vecchia. Mantieni la chiave al sicuro, poiché fornisce accesso diretto ai tuoi crediti prepagati.

Prima richiesta: Completamenti chat

Invia una richiesta standard di completamento chat all'endpoint /v1/chat/completions. L'API accetta un nome del modello, un elenco di messaggi e parametri opzionali. Il nostro ID modello predefinito è uncensored, ottimizzato per risposte di alta qualità e senza restrizioni.

Ecco un esempio di base che utilizza curl per generare una risposta:

Copycurl https://api.serverlessllmapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

La risposta segue il formato JSON standard di OpenAI. Se la richiesta ha esito positivo, riceverai un oggetto di completamento contenente il testo generato. Questa semplicità ti consente di sostituire il nostro endpoint nelle configurazioni SDK OpenAI esistenti semplicemente modificando l'URL di base e la chiave.

Integrazione SDK Python

L'utilizzo dell'SDK Python ufficiale di OpenAI è il modo più veloce per integrare. Poiché la nostra API è compatibile con OpenAI, è sufficiente sovrascrivere l'URL di base e la chiave API. Questo garantisce che il tuo codice esistente funzioni senza modifiche.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.serverlessllmapi.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Questo approccio ti consente di sfruttare le librerie Python familiari beneficiando al contempo del nostro modello senza censura. La finestra di contesto supporta fino a 100.000 token, consentendo lunghezze di input e output consistenti in una singola richiesta. Assicurati che la tua matrice di messaggi includa i prompt di sistema e utente necessari per guidare efficacemente il modello.

Integrazione SDK Node.js

Per gli sviluppatori JavaScript e TypeScript, l'SDK Node di OpenAI offre un percorso di integrazione semplice. Configura il client con il nostro URL di base e la tua chiave API per iniziare a effettuare richieste immediatamente.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.serverlessllmapi.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

Questa configurazione è ideale per funzioni serverless o servizi backend che richiedono interazioni LLM in tempo reale. Il prezzo a consumo significa che paghi solo per ciò che usi, senza abbonamenti mensili. I crediti non scadono, quindi puoi interrompere l'uso tra i progetti senza perdere il saldo.

Risposte in streaming (SSE)

Abilita lo streaming impostando stream: true nella tua richiesta. L'API restituirà uno stream Server-Sent Events (SSE), consentendoti di visualizzare i token man mano che vengono generati. Ciò riduce la latenza percepita per gli utenti finali e migliora l'esperienza per le applicazioni di chat.

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Gestisci gli eventi di stream nel codice client per accumulare la risposta finale. Lo streaming funziona sia con gli SDK Python che Node.js se configurati correttamente. Questa funzione è particolarmente utile per la generazione di contenuti di lunga durata dove il feedback immediato è prezioso.

Limiti di velocità e vincoli

Comprendi i vincoli per garantire un'integrazione fluida. L'API impone un limite di richieste di 300 richieste al minuto per chiave API. Il corpo di ogni richiesta non deve superare 8 MB. Se superi il limite di velocità, riceverai un codice di stato 429.

Gli errori di autenticazione restituiscono un codice di stato 401, indicando una chiave non valida o revocata. Se il tuo credito prepagato è esaurito, le richieste restituiranno un codice di stato 402. L'ID modello uncensored non supporta embedding, generazione di immagini o affinamento. Attieniti ai completamenti di chat basati su testo per prestazioni ottimali.