Dokumentasi API Kompatibel OpenAI

Prasyarat: SDK dan URL Dasar

Mulai dengan menginstal library pilihan Anda dan mengarahkannya ke endpoint kami. The base_url adalah https://api.apicompatible.com/v1. Dokumentasi API yang kompatibel dengan OpenAI ini mengonfirmasi bahwa pustaka standar berfungsi segera. Anda tidak memerlukan router atau pengaturan gateway kompleks. Ubah URL dan kunci, lalu jalankan kode Anda yang ada.

Autentikasi: Format Header dan Kunci

Kirimkan kunci Anda di Authorization header. Gunakan format Bearer your_api_key. API kami menggunakan struktur kunci API standar yang kompatibel dengan OpenAI. Kunci dibuat secara instan melalui login Google atau email. Jaga kunci Anda agar tetap aman, karena kunci ini memberikan akses ke kredit prabayar Anda.

Endpoint Chat Completions

Kirim permintaan ke /v1/chat/completions. Tentukan model sebagai uncensored. API mengembalikan respons teks secara langsung. Gunakan perintah curl berikut untuk memverifikasi konektivitas:

Copycurl https://api.apicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List available models"}]
  }'

Pendekatan yang kompatibel dengan SDK OpenAI ini memastikan Anda mendapatkan generasi teks tanpa batasan. Model ini menangani prompt kompleks tanpa penolakan yang tidak perlu untuk konten yang sah.

Respons Streaming dengan SSE

Aktifkan streaming dengan mengatur stream: true. Respons dikirim melalui Server-Sent Events (SSE). Detail penggunaan token muncul di bagian akhir. Dokumentasi API yang kompatibel dengan OpenAI ini mendukung protokol streaming standar. Gunakan ini untuk pengalaman pengguna secara real-time:

Copyfrom openai import OpenAI

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

Streaming mengurangi latensi yang dirasakan secara signifikan. Berfungsi dengan lancar dengan pustaka sisi klien standar.

Parameter: Suhu, Top-P, dan Tools

Kendalikan generasi dengan parameter standar. Tetapkan temperature untuk keacakan atau top_p untuk sampling nuklir. Aktifkan tools untuk pemanggilan fungsi. Mode JSON tersedia melalui response_format. The uncensored model menghormati batasan-batasan ini secara efektif:

Copyimport OpenAI from "openai";

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

Parameter-parameter ini memungkinkan kontrol halus atas gaya output. Anda dapat memaksakan struktur JSON yang ketat untuk kasus penggunaan pemrograman.

Batas: Batas Kecepatan dan Ukuran Badan

Setiap kunci mengizinkan 300 permintaan per menit. Permintaan simultan dibatasi hingga 8 per kunci. Ukuran body permintaan maksimum adalah 8 MB. Jendela konteks mendukung 100,000 token secara total. Tangani error 401 dengan memeriksa kunci Anda. Selesaikan error 402 dengan mengisi ulang kredit. Kelola error 429 dengan menerapkan logika backoff.

Streaming

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)