Snabbstartsguide för Okänsurerat API

Autentisering och bas-URL

Börja med att peka ditt SDK mot vår bas-URL och skicka din nyckel i autentiseringsheadern. Vi tillhandahåller en direkt, enkel-modelltjänst utan proxy-routningsavgifter. Använd standard Authorization: Bearer schema för att autentisera förfrågningar. Din nyckel genereras omedelbart efter registrering via Google eller e-post. Se till att du ersätter platshållar-nyckeln i din klientkonfiguration med den som visas på din dashboard. Bas-URL:en är https://api.uncensoredmodelsollama.com/v1. Denna slutpunkt stöder standard OpenAI-kompatibla klienter, vilket gör att du kan byta leverantör utan att skriva om din applikationslogik. Behåll din nyckel säker, eftersom den ger åtkomst till din förbetala kreditbalans.

Slutpunkt för chattkomplettering

Skicka textförfrågningar till /v1/chat/completions slutpunkt för att generera svar. Denna slutpunkt hanterar standard konversationshistorik och systemprompter. Du måste ange modell-ID:t som uncensored i begärdekroppen. API:et returnerar JSON-formaterade svar som innehåller genererad text och tokenanvändningsstatistik. Fel som otillräcklig kredit eller ogiltiga nycklar returneras med lämpliga HTTP-statuskoder. Använd denna slutpunkt för alla standard textgenereringsuppgifter. Det stöder inte embeddingar, bilder eller finjustering. Håll din last under 8 MB för att säkerställa pålitlig bearbetning. Modellen bearbetar inmatade och utmatade tokens inom ett gemensamt kontextfönster.

Strömningsresponser

Aktivera strömning genom att ställa in stream parameter till true i din begäran. API:t returnerar Server-Sent Events (SSE) som innehåller inkrementella bitar av text. Denna metod minskar uppfattad latens för användare som väntar på långa utdata. Du tar emot tokenanvändningsinformation i den sista biten av strömmen. Implementera en strömhanterare i din klient för att bearbeta dessa händelser effektivt. Strömning är idealiskt för chattgränssnitt och realtidsapplikationer. Se till att din klientbibliotek stöder SSE-tolkning för att hantera den kontinuerliga dataflödet korrekt. Det totala kontextfönstret förblir 100,000 tokens oavsett strömningsläge.

Funktionsanrop och JSON-läge

Använd den tools parameter för att aktivera funktionsanrop. Definiera dina funktioner i begärandekroppen för att tillåta att modellen returnerar strukturerad data. Ange response_format för {"type": "json_object"} för strikt JSON-utdata. Denna funktion är användbar för att extrahera data eller generera strukturerade laster. Modellen stöder verktygsvalparametrar för att kontrollera beteendet för funktionsanrop. Använd dessa funktioner för att integrera API:t i automatiserade arbetsflöden. Se till att dina funktionsdefinitioner matchar det förväntade inmatningsschemat för pålitliga resultat. API:t returnerar verktygsanrop i standard OpenAI-format för enkel parsing.

Parameters and Rate Limits

Justera genereringsbeteende med parametrar som temperature, top_p, och seed. Ställ in max_tokens att begränsa utdatalängd, med standardvärdet 2 048 om det inte anges. API:t tillämpar en hastighetsbegränsning på 300 begäranden per minut per nyckel. Samtidiga begäranden är begränsade till 8 per nyckel. Om du överskrider dessa gränser returnerar API:t statuskoden 429. Begäranden debiteras baserat på faktisk tokenanvändning, medan fel och avvisningar är kostnadsfria. Krediten löper inte ut, och förbetalda belopp är transparenta. Hantera dina nycklar noggrant, eftersom varje konto endast stöder en aktiv nyckel i taget.

Gränser, fel och kontext

Kontextrutan stöder 100 000 tokens för kombinerad inmatning och utmatning. Begäranden som överskrider 8 MB-gränsen för body kommer att misslyckas. Vanliga fel inkluderar 401 för ogiltiga nycklar och 402 för otillräckligt kredit. Hantera dessa fel på ett smidigt sätt i din applikationslogik. API:t vägrar begäranden som innehåller sexuellt innehåll med minderåriga, oavsett andra inställningar. Övrigt innehåll är ocensurerat för laglig vuxenanvändning. Övervaka din tokenanvändning för att undvika oväntade kostnader. Systemet med förbetald kredit säkerställer att du bara betalar för det du använder. Inga abonnemangskostnader eller dolda avgifter tillkommer till din integration.

cURL

Copycurl https://api.uncensoredmodelsollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List all available models in the ollama library."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

Strömning

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)