Dokumentasi API

Pengesahan & URL Asas

Gunakan kunci API anda dengan URL asas https://api.paidapi.cc/v1. Lulus kunci dalam Authorization pencap sebagai token Bearer. Tetapan ini berfungsi dengan mana-mana perpustakaan klien serasi OpenAI tanpa langkah konfigurasi tambahan.

Copycurl https://api.paidapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set up a cron job to run every hour"}]
  }'

Kekalkan kunci anda selamat. Jika anda kehilangannya, jana kunci baru dari papan pemuka anda. Kunci lama akan berhenti berfungsi serta-merta.

Permintaan Pertama

Hantar permintaan POST ke /v1/chat/completions dengan model "uncensored". Sertakan array mesej anda dalam badan. API mengembalikan penyelesaian teks berdasarkan konteks prompt anda.

Copyfrom openai import OpenAI

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

Panggilan mudah ini mengesahkan integrasi anda berfungsi. Semak objek respons untuk penggunaan token dan kandungan.

Respons Streaming

Aktifkan aliran dengan menetapkan stream: true. API ini menghantar keping separa seperti yang dijana. Ini mengurangkan latensi yang dirasakan untuk output panjang.

Copyimport OpenAI from "openai";

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

Kendalikan setiap pecahan secara berasingan. Kumpulkan mereka untuk membina respons akhir. Pecahan terakhir mengandungi jumlah penggunaan token untuk permintaan tersebut.

Panggilan Fungsi & Alat

Takrifkan alat dalam badan permintaan anda. Model memulangkan panggilan alat apabila sesuai. Huraikan nama fungsi dan hujah daripada respons.

Tetapkan tool_choice untuk mengawal bila model menggunakan alat. Gunakan "auto" untuk pemilihan automatik atau nyatakan nama alat. Ciri ini berfungsi dengan boleh dipercayai dengan model tanpa sensor kami untuk tugas kompleks.

Konfigurasi Mod JSON

Tetapkan response_format ke {"type": "json_object"}. Model ini menyusun output sebagai JSON yang sah. Ini memudahkan penguraian untuk aliran kerja berprogram.

Pastu prompt anda menentukan skema JSON dengan jelas. Model mematuhi struktur yang anda takrifkan. Gunakan mod ini untuk pengeluaran data atau tugas penjanaan terstruktur.

Had Kadar & Ralat

Anda mendapat 300 permintaan setiap minit dan 8 permintaan serentak setiap kunci. Melebihi had ini mengembalikan ralat 429. Badan permintaan mesti kekal di bawah 8 MB. Tetingkap konteks ialah 100,000 token secara keseluruhan.

Tangani ralat 401 dengan mengesahkan kunci anda. Ralat 402 bermaksud anda memerlukan lebih kredit. Ralat tidak menggunakan token. Pastikan kredit pra-dibayar anda sentiasa ditambah nilai untuk mengelakkan gangguan.

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)