API-dokumentation

Snabbstart din första begäran

Börja generera text omedelbart genom att peka din klient mot vår bas-URL och autentisera med en genererad API-nyckel. Gränssnittet följer standardkonventioner, så du kan använda befintliga SDK:er utan att lära dig ett nytt protokoll. Du skickar prompts till uncensored modellen och ta emot text svar som inte tillämpar vanliga innehållsfilter för laglig vuxen användning.

Konfigurera bas-URL:en och nyckel

Ställ in dina miljövariabler för att dirigerar förfrågningar till vår specifika slutpunkt. Ersätt platshållaryckeln med den som genererades vid registreringen. Detta säkerställer att alla efterföljande anrop använder rätt uncensored-modellinstans.

• Bas-URL: https://api.nsfwlocalllm.com/v1
• Auth-huvud: Authorization: Bearer YOUR_API_KEY

Du kan verifiera att din nyckel fungerar genom att kontrollera models-slutpunkten. En giltig nyckel returnerar den tillgängliga modell-ID:t omedelbart.

Skicka en chat-completion-förfrågan

Skicka en standard chat completion-payload för att generera text. Systemet bearbetar din input och returnerar modellens svar. Använd uncensored modell-ID för att säkerställa att du når den ofiltrerade instansen.

Svaret inkluderar den genererade texten och statistik över tokenanvändning. Du kan parsera detta direkt in i din applikationslogik.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Kontrollera för standard HTTP-statuskoder för att hantera framgångs- eller missfallsscenarier.

Aktivera strömning för realtidsutdata

Strömma svar för att minska upplevd latens för dina användare. Aktivera strömning genom att ställa in stream: true i din förfrågningskropp. API:et returnerar en serie Server-Sent Events (SSE) som innehåller delvis genererade tokens.

Aggera dessa tokens på klientidan för att rekonstruera hela meddelandet. Denna metod är idealisk för chattgränssnitt där omedelbar återkoppling är viktig. den sista SSE-händelsen innehåller total tokenanvändning för förfrågan.

Copyfrom openai import OpenAI

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

Hantera anslutningsfel smidigt för att säkerställa en smidig användarupplevelse.

Använd JSON-läge för strukturerad data

Tvinga modellen att returnera giltig JSON för programmatisk konsumtion. Ställ in response_format för {"type": "json_object"} i ditt begäran. Detta minskar parsningsfel och säkerställer konsekventa datastrukturer.

Använd detta för att generera strukturerade promptar, extrahera entiteter eller bygga dynamiskt innehåll. Modellen följer formatbegränsningarna som anges i dina systeminstruktioner. Detta är avgörande för pålitlig integration med andra tjänster.

Copyimport OpenAI from "openai";

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

Validera JSON-utmatningen på din sida för att fånga eventuella kantfall.

Implementera funktionsanrop

Definiera verktyg för att utöka modellens funktioner. Skicka en tools array med funktionsdefinitioner till begäran. Modellen kan välja att anropa dessa funktioner baserat på sammanhanget.

Detta möjliggör komplexa arbetsflöden där LLM:en bestämmer när den ska hämta data eller utföra åtgärder. Du får funktionsargumenten i svaret och exekverar dem på din sida. Skicka tillbaka resultaten till modellen för ytterligare resonemang.

Ställ in tool_choice för auto för flexibel beslutsfattande. Denna funktion stöder avancerade rollspelsscenarier som kräver åtkomst till extern data.

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)