Dokumentasi API

Pengesahan dan URL Asas

API memerlukan token pembawa untuk setiap permintaan. Jana kunci anda di halaman Dapatkan Kunci API dengan mendaftar masuk menggunakan Google atau kata laluan e-mel. Kunci muncul serta-merta tanpa pengesahan telefon. Gunakan URL asas https://api.uncensoredaigithub.com/v1 dengan SDK rasmi OpenAI dengan mengemas kini base_url dan api_key nilai. Sediaan ini berfungsi dengan mana-mana klien serasi OpenAI.

Titik akhir: https://api.uncensoredaigithub.com/v1

Header Auth: Authorization: Bearer YOUR_API_KEY

Setiap akaun menyokong satu kunci aktif. Penerbitan kunci bah secara automatik akan membatalkan kunci sebelumnya. Ini mencegah hanyutan token apabila anda menggilap kelayakan merentasi persekitaran yang berbeza.

Hujung Sambungan Penyelesaian Sembang

Hantar permintaan teks ke /v1/chat/completions endpoint menggunakan ID model uncensored. API menerima mesej semakan standard dan mengembalikan respons teks tanpa tapisan kandungan untuk penggunaan dewasa yang sah. Anda boleh mengkonfigurasi parameter seperti temperature, top_p, dan stop untuk mengawal kreativiti dan panjang output.

Jendela konteks membolehkan sehingga 100,000 token untuk gabungan prompt dan penyelesaian. Tetapkan max_tokens untuk mengawal output, dengan lalai 2,048 token jika diabaikan. Ralat dan penolakan tidak menggunakan kredit, jadi anda boleh menguji dengan selamat.

Penggunaan Respons Streaming

Aktifkan aliran dengan menetapkan stream: true dalam permintaan anda. API mengembalikan Acara Dihantar Pelayan (SSE) mengandungi potongan teks separa. Data penggunaan token muncul hanya dalam potongan akhir aliran. Ini membolehkan perenderan respons secara masa nyata sambil menjejakan penggunaan dengan tepat.

Streaming sesuai untuk aplikasi roleplay atau penjanaan kandungan bentuk panjang. Anda boleh menguraikan aliran SSE untuk mengemas kini UI secara berperingkat. API memastikan metrik penggunaan kekal tepat walaupun sambungan terputus lebih awal.

Panggilan Fungsi dan Alat

Menyokong pemanggilan fungsi dengan menyediakan tools array in the request. The model can return structured tool calls with arguments. Use tool_choice untuk memaksakan tingkah laku khusus, seperti pelaksanaan fungsi automatik. Ciri ini membolehkan integrasi dengan perkhidmatan luaran atau logik tersuai.

Takrifkan fungsi dengan nama, penerangan, dan skema parameter. API mengembalikan nama fungsi dan hujah dalam respons. Huraikan hujah-hujah ini untuk melaksanakan kod tersuai anda. Keupayaan ini menjadikan API LLM uncensored sesuai untuk aliran kerja agen kompleks.

Mod JSON dan Parameter

Paksa output terstruktur dengan menetapkan response_format ke {"type": "json_object"}. Model ini akan mengembalikan JSON bukan teks biasa. Ini berguna untuk pengekstrakan data atau penjanaan konfigurasi. Gabungkan ini dengan pemanggilan fungsi untuk integrasi API yang kukuh.

Parameter sokongan lain termasuk seed untuk output deterministik, presence_penalty, dan frequency_penalty. Gunakan seed untuk meniru respons tertentu bagi tujuan nyahpepijat. Laraskan penalti untuk mengurangkan pengulangan atau menggalakkan kosakata yang pelbagai dalam output anda.

Pengendalian Ralat dan Had

API ini mengenakan had kadar sebanyak 300 permintaan setiap minit dan 8 permintaan serentak setiap kunci. Badan permintaan tidak boleh melebihi 8 MB. Jika anda melebihi had ini, anda akan menerima kod status 429. Kegagalan pengesahan akan memulangkan ralat 401. Kredit yang tidak mencukupi akan mencetuskan ralat 402.

Kredit dikenakan berdasarkan penggunaan token sebenar. Kredit pra-bayar tidak pernah luput, jadi anda tidak perlu risau tentang pembaharuan bulanan. Gunakan halaman Sokongan untuk menyelesaikan isu seperti caj berganda.

cURL

Copycurl https://api.uncensoredaigithub.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the unit tests for the new auth module."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

Aliran

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)