Documentazione API & Guida Rapida

URL Base e Autenticazione

Usa il nostro URL di base e una singola chiave API per connetterti. L'endpoint accetta intestazioni standard. Sostituisci YOUR_API_KEY con la stringa dal tuo dashboard.

• Base URL: https://api.ollamaopenaicompatibleapi.com/v1
• ID modello: uncensored

L'autenticazione si basa su un token bearer. Passalo nell' Authorization header. Questo garantisce la compatibilità con qualsiasi client compatibile con SDK OpenAI. Puoi generare una nuova chiave istantaneamente tramite Google o email. Non è richiesto un numero di telefono.

Endpoint Chat Completions

Invia una richiesta POST a /v1/chat/completions. Includi il tuo array messages e il nome del modello. L'API restituisce un output testuale basato sul tuo prompt. Questo funziona con qualsiasi provider che utilizza parametri standard.

Imposta la temperatura per la creatività o mantienila bassa per la precisione. Puoi anche definire sequenze di stop. Il server elabora la richiesta e restituisce il completamento. Questa è l'interazione principale per la maggior parte delle integrazioni.

Ricorda che gli errori non consumano il tuo credito prepagato. Solo i completamenti di successo vengono fatturati. Questo protegge il tuo budget durante le fasi di debug.

Copycurl https://api.ollamaopenaicompatibleapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 10 Linux kernel security patches from 2023"}]
  }'

Risposte in streaming tramite SSE

Abilita lo streaming impostando stream: true. Il server invia chunk man mano che vengono generati. Questo riduce significativamente la latenza percepita. Ricevi risposte parziali in tempo reale.

Analizza il flusso Server-Sent Events. L'ultimo chunk contiene le statistiche di utilizzo. Include i conteggi dei token sia per l'input che per l'output. Puoi monitorare i costi dinamicamente durante la generazione.

Questo approccio funziona bene per le interfacce chat. Gli utenti vedono il testo apparire parola per parola. Sembra più reattivo che aspettare la risposta completa. L'API gestisce automaticamente la stabilità della connessione.

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)

Function Calling e modalità JSON

Definisci gli strumenti nel corpo della richiesta. Il modello può generare dati strutturati. Usa response_format con {"type": "json_object"} per JSON rigoroso. Questo garantisce un output analizzabile ogni volta.

Le definizioni degli strumenti includono nome, descrizione e parametri. Il modello decide quale strumento chiamare. Esecuti la funzione e restituisci i risultati. Questo abilita flussi di lavoro complessi per gli agent.

La modalità JSON disabilita la generazione di testo libero. Forza il modello a aderire al tuo schema. Usalo quando integri con database o API. Riduce le allucinazioni nei campi strutturati.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaopenaicompatibleapi.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)

Limiti di frequenza e corpi delle richieste

Ricevi 300 richieste al minuto per chiave. La concorrenza è limitata a 8 richieste simultanee. La dimensione massima del corpo della richiesta è di 8 MB. Questo è adatto alla maggior parte delle applicazioni basate su testo.

La finestra di contesto consente 100.000 token in totale. Questo include sia il prompt che il completamento. L'output massimo per richiesta è di 16.000 token. Se ometti max_tokens, il valore predefinito è 2.048.

Gestisci gli errori HTTP 429 in modo elegante. Indicano che hai raggiunto il limite di frequenza. Implementa un backoff esponenziale nel codice del tuo client. Questo evita di sovraccaricare il server durante i picchi.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamaopenaicompatibleapi.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);

Errori di Autenticazione e Limiti

Un codice di stato 401 indica che la tua chiave API non è valida. Controlla eventuali errori di battitura o sessioni scadute. Un codice 402 segnala credito insufficiente. Aggiungi fondi tramite criptovalute per riprendere il servizio.

Un codice di stato 429 segnala il rate limiting. Hai superato le 300 richieste al minuto. Riduci il throughput o aggiorna la tua chiave. L'API restituisce messaggi di errore chiari.

Il credito non scade mai. Puoi ricaricare in qualsiasi momento. La ricarica minima è di $20. I crediti bonus si applicano per importi più elevati. Questo mantiene il tuo progetto in esecuzione senza intoppi.