Dokumentasi API

URL Asas dan Pengesahan

Titik akhir API terletak di https://api.openrouteraiapi.com/v1. Lulus kunci API anda dalam Authorization header sebagai token bearer. Ini adalah satu-satunya perubahan yang diperlukan untuk mengalihkan trafik dari penyedia semasa anda ke model tanpa sensor kami.

Pengesahihan adalah ketat. Jika kunci tiada atau tidak sah, pelayan mengembalikan ralat 401 serta-merta. Anda boleh menjana kunci serta-merta melalui Google atau e-mel di papan pemuka. Simpan kunci dengan selamat, kerana ia memberikan akses kepada kredit pra-dibayar anda.

Hujung Sambungan Penyelesaian Sembang

Hantar permintaan POST ke /v1/chat/completions dengan array mesej. Pengenal model ialah uncensored. Model tunggal ini mengendalikan semua keperluan penjanaan teks anda tanpa logik pengaliran yang kompleks.

Berikut adalah permintaan piawai menggunakan cURL untuk mengesahkan sambungan dan format respons.

Copycurl https://api.openrouteraiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list the top five python libraries for data science"}]
  }'

Respons termasuk teks yang dijana dalam choices[0].message.content bidang. Anda boleh menguraikan ini terus ke dalam aliran kerja aplikasi anda.

Integrasi SDK Python

Gunakan klien Python OpenAI rasmi untuk menyambung dengan mudah. Tetapkan base_url dan api_key pemboleh ubah untuk menunjuk ke infrastruktur kami. Pendekatan ini meminimumkan perubahan kod apabila menukar penyedia.

Copyfrom openai import OpenAI

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

Pelanggan mengendalikan serialisasi dan percubaan semula secara automatik. Anda menerima objek penyelesaian yang mengandungi teks dan statistik penggunaan token. Kaedah ini sangat sesuai untuk perkhidmatan backend dan skrip.

Penggunaan SDK Node.js

Mulakan klien Node.js OpenAI dengan URL asas tersuai anda. Ini membolehkan aplikasi JavaScript berinteraksi dengan model tanpa menggunakan kaedah yang biasa. SDK menguruskan permintaan HTTP dengan cekap.

Copyimport OpenAI from "openai";

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

Panggil chat.completions.create() dengan mesej anda. Objek respon memberikan akses kepada kandungan yang dijana dan data penggunaan. Integrasi ini berfungsi dengan baik untuk pelayan web dan fungsi tepi.

Respons Streaming

Aktifkan aliran dengan menetapkan stream: true dalam permintaan anda. pelayan mengembalikan Acara Dihantar Pelayan (SSE) untuk penghantaran token masa nyata. Ciri ini mengurangkan latensi yang dirasakan untuk pengguna akhir.

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)

Setiap chunk mengandungi kandungan separa. Chunk akhir termasuk statistik penggunaan token lengkap. Tangani acara ini dalam klien anda untuk mengemas kini UI secara berperingkat.

Had, Ralat, dan Tetingkap Konteks

Jendela konteks menyokong 100,000 token untuk input dan output gabungan. Setiap permintaan boleh menghasilkan sehingga 16,000 token, atau 2,048 jika max_tokens tidak ditetapkan. Had kadar membolehkan 300 permintaan setiap minit per kunci.

Ralat adalah kod HTTP piawai. 401 menunjukkan kunci tidak sah. 402 bermaksud kredit prabayar anda telah habis. 429 menandakan anda telah melebihi had kadar. Permintaan yang gagal tidak menggunakan kredit. Ralat adalah percuma.