Dokumentacja API

Szybki start: Pierwsze żądanie w Python lub JS

Wyślij pierwszy prompt i natychmiast otrzymaj surowy tekst wyjściowy. API akceptuje standardowe ładunki chat-completion, więc możesz podmienić nasz bazowy adres URL i klucz, aby zacząć generować treści uncensored bez przepisywania logiki. Użyj poniższego polecenia cURL, aby zweryfikować łączność i dostępność modelu przed integracją w kodzie.

To początkowe żądanie potwierdza, że endpoint jest osiągalny i że Twój token uwierzytelniający jest ważny. Możesz następnie przejść do budowania logiki aplikacji, używając dostarczonych wrapperów SDK.

Copycurl https://api.chatunrestricted.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the three main endpoints for user authentication"}]
  }'

Uwierzytelnianie & URL bazowy

Uwierzytelnij, przekazując swój klucz API w nagłówku HTTP. Wszystkie żądania muszą kierować się do URL bazowego https://api.chatunrestricted.com/v1 do zapewnienia kompatybilności z SDK OpenAI. Możesz wygenerować swój klucz natychmiast przez panel sterowania za pomocą poświadczeń Google lub e-mail, bez konieczności podawania numeru telefonu.

Klucz API identyfikuje Twoje konto i śledzi zużycie tokenów względem Twojego salda z góry opłaconego. Chroń ten klucz, ponieważ zapewnia bezpośredni dostęp do Twojego kredytu. Dozwolony jest tylko jeden aktywny klucz na konto; wygenerowanie nowego automatycznie unieważnia poprzedni klucz.

POST /v1/chat/completions

Generuj tekst wysyłając żądanie POST do endpointu uzupełnień czatu. ID modelu to uncensored, który uruchamia model o otwartych wagach dostrojony do odpowiadania bez odmów treści dla prawnego użytku dorosłego. Możesz kontrolować długość wyjścia, losowość i warunki zatrzymania za pomocą standardowych parametrów.

To endpoint obsługuje strumieniowanie, wywoływanie funkcji oraz odpowiedzi w formacie JSON. Nie obsługuje osadzania (embeddings), obrazów ani dostrajania (fine-tuning). Użyj biblioteki Python SDK do obsługi żądania asynchronicznie, aby uzyskać lepszą wydajność w aplikacjach webowych.

Copyfrom openai import OpenAI

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

GET /v1/models

Pobierz listę dostępnych modeli, aby potwierdzić strukturę API. Odpowiedź zawiera uncensored ID modelu, który musisz określić w swoich żądaniach completion. Ten punkt końcowy pomaga Ci zweryfikować, że usługa jest online i że ID modelu się nie zmieniło.

Użyj tego endpointu do debugowania problemów z łącznością przed wysłaniem drogich żądań generowania. Zwraca standardowe metadane modelu zgodne z OpenAI, w tym identyfikator modelu i typ obiektu.

Copyimport OpenAI from "openai";

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

Parametry: Temperatura, Top P, Seed

Steruj losowością i determinizmem swoich outputów za pomocą standardowych parametrów próbkowania. Ustaw temperature między 0 a 2, aby dostosować kreatywność, i użyj top_p ograniczyć próbkowanie jądra. The seed parameter pozwala na odtworzenie konkretnych wyników do debugowania lub scenariuszy roleplay.

Te parametry bezpośrednio wpływają na to, jak model generuje tekst. Wyższe temperatury generują bardziej zróżnicowane odpowiedzi, podczas gdy niższe temperatury sprawiają, że wyjście jest bardziej skupione i przewidywalne. Użyj stop sekwencje do zatrzymywania generowania na konkretnych znacznikach.

Strumieniowanie, Narzędzia i Tryb JSON

Strumieniuj odpowiedzi w czasie rzeczywistym, używając Eventów Wysyłanych przez Serwer (SSE), aby zmniejszyć opóźnienia. Włącz tryb JSON, ustawiając response_format do json_object do ekstrakcji danych strukturalnych. Wywoływanie narzędzi jest obsługiwane dla wykonania funkcji, pozwalając modelowi na wywoływanie zewnętrznych API.

Strumieniowanie jest kluczowe do budowania interfejsów czatu, które wyświetlają tokeny w miarę ich generowania. Ostatni fragment strumienia zawiera całkowite zużycie tokenów dla żądania, umożliwiając dokładne śledzenie rozliczeń. Użyj poniższego przykładu, aby zaimplementować strumieniowanie w swojej aplikacji.

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 prędkości a rozliczenia

Monitoruj swoje limity szybkości, aby uniknąć przerw w usłudze podczas dużego obciążenia. API narzuca limit 300 żądań na minutę i limit równoległości 8 jednoczesnych żądań na klucz. Maksymalny rozmiar ciała żądania to 8 MB.

Rozliczenia są prepay i opierają się na rzeczywistym zużyciu tokenów. Błędy i odrzucenia nie zużywają kredytu. Jeśli napotkasz błąd 401, Twój klucz API jest nieprawidłowy. Błąd 402 oznacza niewystarczający kredyt, podczas gdy błąd 429 oznacza przekroczenie limitu szybkości. Okno kontekstowe obsługuje 100,000 tokenów łącznie dla promptu i completion.