API-documentatie: Quickstart

Base URL en authenticatie

De serverless llm API gebruikt de standaard OpenAI-compatible endpointstructuur. Om aan de slag te gaan, heb je twee dingen nodig: je base URL en je API-sleutel.

Gebruik de volgende base URL voor alle verzoeken:

https://api.serverlessllmapi.com/v1

Authenticatie wordt afgehandeld via de Authorization-header. Maak een account aan op de pagina API-sleutel ophalen om je sleutel te ontvangen. Je kunt deze sleutel op elk moment opnieuw genereren, waardoor de oude sleutel direct ongeldig wordt. Bewaar je sleutel veilig, omdat deze directe toegang geeft tot je prepaid tegoed.

Eerste verzoek: Chat-completies

Stuur een standaard chat-completion-verzoek naar het /v1/chat/completions-endpoint. De API accepteert een modelnaam, een lijst met berichten en optionele parameters. Ons standaard model-ID is uncensored, geoptimaliseerd voor hoogwaardige, onbeperkte antwoorden.

Hier is een basisvoorbeeld met curl om een antwoord te genereren:

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."}]
  }'

Het antwoord volgt de standaard OpenAI JSON-indeling. Als het verzoek succesvol is, ontvang je een completion-object met de gegenereerde tekst. Deze eenvoud stelt je in staat ons endpoint in bestaande OpenAI SDK-configuraties te plaatsen door simpelweg de base URL en sleutel aan te passen.

Python SDK-integratie

Het gebruik van de officiële OpenAI Python SDK is de snelste manier tot integratie. Omdat onze API openai compatible api is, hoef je alleen de base URL en API-sleutel te overschrijven. Dit zorgt ervoor dat je bestaande code zonder aanpassingen werkt.

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)

Deze aanpak stelt je in staat bekende Python-bibliotheken te gebruiken, terwijl je profiteert van ons ongecensureerde model. Het contextvenster ondersteunt tot 100.000 tokens, waardoor je aanzienlijke invoer- en uitvoerlengtes binnen één verzoek kunt verwerken. Zorg ervoor dat je berichtenarray de nodige system- en user-prompts bevat om het model effectief te sturen.

Node.js SDK-integratie

Voor JavaScript- en TypeScript-ontwikkelaars biedt de OpenAI Node SDK een eenvoudige integratiemogelijkheid. Configureer de client met onze base URL en je API-sleutel om direct verzoeken te kunnen uitvoeren.

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);

Deze setup is ideaal voor serverless-functies of backend-diensten die realtime LLM-interacties vereisen. De pay-as-you-go-prijzen betekenen dat je alleen betaalt voor wat je gebruikt, zonder maandelijkse abonnementen. Credits vervallen niet, dus je kunt het gebruik tussen projecten onderbreken zonder je saldo te verliezen.

Streaming-antwoorden (SSE)

Schakel streaming in door stream: true in je verzoek in te stellen. De API retourneert een Server-Sent Events (SSE)-stream, waardoor je tokens kunt weergeven zodra ze worden gegenereerd. Dit vermindert de waargenomen latentie voor eindgebruikers en verbetert de ervaring voor chattoepassingen.

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)

Verwerk de stream-events in je clientcode om het uiteindelijke antwoord op te bouwen. Streaming werkt met zowel de Python- als de Node SDK's wanneer ze correct zijn geconfigureerd. Deze functie is vooral nuttig voor het genereren van lange teksten, waar directe feedback waardevol is.

Rate limits en beperkingen

Begrijp de beperkingen om een vlotte integratie te garanderen. De API handhaaft een rate limit van 300 verzoeken per minuut per API-sleutel. Elke request body mag niet groter zijn dan 8 MB. Als je het rate limit overschrijdt, ontvang je een 429-statuscode.

Authenticatiefouten retourneren een 401-status, wat wijst op een ongeldige of ingetrokken sleutel. Als je prepaid tegoed opgebruikt is, retourneren verzoeken een 402-status. Het model-ID uncensored ondersteunt geen embeddings, image generation of fine-tuning. Houd je aan tekstgebaseerde chat-completies voor optimale prestaties.