Dokumentacja API & Szybki Start

Bazowy URL i autoryzacja

Użyj naszego adresu bazowego i pojedynczego klucza API do połączenia. Punkt końcowy akceptuje standardowe nagłówki. Zastąp YOUR_API_KEY ciąg znakem z Twojego panelu.

• URL bazowy: https://api.ollamaopenaicompatibleapi.com/v1
• ID modelu: uncensored

Uwierzytelnianie opiera się na tokenie bearer. Przekaż go w Authorization Nagłówek. To zapewnia kompatybilność z dowolnym klientem kompatybilnym z SDK OpenAI. Możesz wygenerować nowy klucz natychmiast przez Google lub e-mail. Nie jest wymagany numer telefonu.

Punkt końcowy Uzupełnień Czat

Wyślij żądanie POST do /v1/chat/completions. Dołącz tablicę wiadomości i nazwę modelu. API zwraca tekst wyjściowy na podstawie Twojego promptu. Działa z dowolnym dostawcą używającym standardowych parametrów.

Ustaw temperaturę dla kreatywności lub zachowaj ją niską dla precyzji. Możesz również zdefiniować sekwencje stopu. Serwer przetwarza żądanie i zwraca uzupełnienie. To jest podstawowa interakcja dla większości integracji.

Pamiętaj, że błędy nie zużywają Twojego kredytu prepayowanego. Tylko udane uzupełnienia są rozliczane. Chroni to Twój budżet podczas faz debugowania.

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

Odpowiedzi strumieniowe przez SSE

Włącz strumieniowanie, ustawiając stream: true. Serwer wysyła fragmenty w miarę ich generowania. Zmniejsza to postrzeganą latencję znacznie. Otrzymujesz częściowe odpowiedzi w czasie rzeczywistym.

Przeanalizuj strumień Server-Sent Events. Ostatni fragment zawiera statystyki użycia. Obejmuje to liczniki tokenów zarówno dla danych wejściowych, jak i wyjściowych. Możesz śledzić koszty dynamicznie podczas generowania.

Podejście to dobrze działa dla interfejsów czatu. Użytkownicy widzą tekst pojawiający się słowo po słowie. Wygląda bardziej responsywnie niż oczekiwanie na pełną odpowiedź. API automatycznie obsługuje stabilność połączenia.

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)

Wywoływanie funkcji i tryb JSON

Zdefiniuj narzędzia w ciele żądania. Model może zwracać dane strukturalne. Użyj response_format z {"type": "json_object"} do ścisłego formatu JSON. To zapewnia poprawnie zparseowany wynik za każdym razem.

Definicje narzędzi obejmują nazwę, opis i parametry. Model decyduje, które narzędzie wywołać. Wykonujesz funkcję i przekazujesz wyniki z powrotem. Umożliwia to złożone przepływy pracy agentów.

tryb JSON wyłącza generowanie tekstu swobodnego. Wymusza na modelu przestrzeganie Twojego schematu. Używaj tego podczas integracji z bazami danych lub API. Zmniejsza halucynacje w polach strukturalnych.

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)

Limity szybkości i ciała żądań

Otrzymujesz 300 żądań na minutę na klucz. Równoległość jest ograniczona do 8 jednoczesnych żądań. Maksymalny rozmiar treści żądania to 8 MB. Pasuje to do większości aplikacji tekstowych.

Okno kontekstowe pozwala na 100 000 tokenów łącznie. Obejmuje to zarówno prompt, jak i uzupełnienie. Maksymalne wyjście na żądanie wynosi 16 000 tokenów. Jeśli pominię max_tokens, domyślnie wynosi 2,048.

Obsłuż błędy HTTP 429 w sposób graceful. Oznaczają one przekroczenie limitu szybkości. Zaimplementuj wykładnicze opóźnienie (backoff) w kodzie klienta. Zapobiega to przeciążeniu serwera podczas szczytów ruchu.

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

Błędy uwierzytelniania i limity

Kod 401 oznacza, że Twój klucz jest nieprawidłowy. Sprawdź literówki lub wygasłe sesje. Kod 402 oznacza niewystarczające środki. Doładuj konto kryptowalutą, aby wznowić usługę.

Kod stanu 426 oznacza ograniczenie szybkości. Przekroczyłeś 300 żądań na minutę. Zmniejsz przepustowość lub uaktualnij swój klucz. API zwraca jasne komunikaty o błędach.

Kredyt nie wygasa. Możesz doładować środki w dowolnym momencie. Minimalna kwota doładowania to $20. Bonusowe kredyty stosuje się przy większych kwotach. Dzięki temu Twój projekt działa płynnie.