Dokumentacja dla klucza API zgodnego z OpenAI

Uwierzytelnianie i URL bazowy

Użyj wygenerowanego klucza z podanym bazowym adresem URL, aby połączyć się natychmiast. Punkt końcowy to https://api.openaicompatibleapikey.com/v1 i działa z dowolnym klientem kompatybilnym z OpenAI. Otrzymujesz jeden aktywny klucz na konto; wygenerowanie nowego zastępuje stary. Uwierzytelnianie obsługiwane jest poprzez Authorization Nagłówek z Bearer schemat. Nie jest wymagany numer telefonu do rejestracji, a możesz zacząć od darmowej próby za $0.50.

Pierwsze żądanie z użyciem curl

Wyślij prostą wiadomość, aby zweryfikować połączenie i model uncensored. Żądanie używa standardowego POST /v1/chat/completions endpoint z ustawionym identyfikatorem modelu na uncensored.To potwierdza, że Twój klucz API jest ważny, a punkt końcowy jest osiągalny przed integracją go w Twojej aplikacji. Odpowiedź zawiera zużycie tokenów i wygenerowany tekst.

Copycurl https://api.openaicompatibleapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Calculate the total price including tax"}]
  }'

Integracja Python SDK

Zintegruj interfejs API ze swoimi projektami Python, nadpisując domyślny adres bazowy. Pozwala to na korzystanie z oficjalnego openai biblioteką z naszym LLM niecenzurowanym bez zmiany logiki kodu. Przekaż swój klucz API i określony base_url do inicjalizacji klienta. ID modelu pozostaje uncensored dla wszystkich żądań.

Copyfrom openai import OpenAI

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

Integracja SDK Node

Podłącz aplikacje Node.js, ustawiając baseURL i apiKey właściwości. Gwarantuje to kompatybilność z istniejącym kodem klienta zgodnego z OpenAI. Możesz kontynuować używanie standardowych parametrów, takich jak messages i model. Klient będzie kierować żądania do naszych serwerów hostowanych w celu generowania treści bez cenzury.

Copyimport OpenAI from "openai";

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

Strumieniowanie odpowiedzi i zużycie tokenów

Włącz strumieniowanie, ustawiając stream: true w parametrach żądania. API zwraca zdarzenia wysyłane serwerowo (SSE) dla dostarczania tokenów w czasie rzeczywistym. Szczegóły zużycia tokenów są zawarte w ostatnim fragmencie strumienia. Pozwala to monitorować koszty i użycie kontekstu podczas generowania tekstu. Model obsługuje okno kontekstu o rozmiarze 100,000 tokenów.

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)

Limity szybkości, błędy i limity

Monitoruj swoją kwotę, aby uniknąć przerw w usłudze. Limit to 300 żądań na minutę na klucz i 8 żądań równoległych. Błąd 401 wskazuje na nieprawidłowy klucz, podczas gdy 402 sygnalizuje niewystarczający kredyt. Błędy i odmowy są darmowe. Okno kontekstowe ma 100 000 tokenów, z maksymalnym wyjściem 16 000 tokenów na żądanie. Kredyt nigdy nie wygasa.