th ▾
เริ่มต้นเลย

Apertus ia API Documentation

เชื่อมต่อเครื่องมือที่มีอยู่กับ ไม่เซ็นเซอร์ ia ด้วยคีย์ API เพียงคีย์เดียวและเอนด์พอยต์ที่เข้ากันได้กับ OpenAI มาตรฐาน

1. Quickstart: Connect Your First Request

URL ฐานคือ https://api.apertusia.com/v1 ส่งคีย์ API ของคุณในหัว Authorization รหัสโมเดลคือ uncensored การตั้งค่านี้ใช้งานได้กับไคลเอนต์ที่เข้ากันได้กับ OpenAI ใดๆ

ใช้คำสั่ง cURL นี้เพื่อทดสอบการเชื่อมต่อทันที แทนที่ YOUR_API_KEY ด้วยคีย์ของคุณ

curl https://api.apertusia.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "List the top 5 python libraries for web scraping"}]
  }'

ข้อผิดพลาดในการตรวจสอบสิทธิ์จะส่งค่า 401 เงินไม่เพียงพอจะส่งค่า 402 ขีดจำกัดอัตราการใช้งานจะส่งค่า 429

2. พารามิเตอร์ที่รองรับ: Temperature, Top P และ Seed

ควบคุมความสุ่มด้วย temperature, ความหลากหลายด้วย top_p และความสามารถในการทำซ้ำด้วย seed พารามิเตอร์เหล่านี้ปฏิบัติตามมาตรฐานของ OpenAI ตั้งค่า temperature เป็น 0.7 เพื่อผลลัพธ์ที่สมดุล หรือ 1.0 เพื่อความคิดสร้างสรรค์ที่สูงขึ้น ใช้ top_p เพื่อจำกัดการสุ่มเลือกเฉพาะความน่าจะเป็นสูงสุด พารามิเตอร์ seed รับประกันผลลัพธ์ที่เหมือนกันสำหรับการดีบัก

ตัวอย่างโค้ด Python สำหรับทดสอบในเครื่อง:

from openai import OpenAI

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

3. การตอบสนองแบบสตรีมด้วย Server-Sent Events

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true API จะส่งข้อมูลแบบ chunk ผ่าน Server-Sent Events แต่ละ chunk จะประกอบด้วยข้อความบางส่วนและข้อมูลการใช้งาน token เพื่อลดความล่าช้าที่ผู้ใช้รู้สึกเมื่อตอบกลับยาวๆ จัดการเหตุการณ์ SSE เพื่ออัปเดต UI ของคุณแบบเรียลไทม์

ตัวอย่าง Node.js โดยใช้ SDK ทางการ:

import OpenAI from "openai";

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

4. การกำหนดค่า Function Calling และโหมด JSON

ใช้ response_format พร้อม {"type": "json_object"} เพื่อผลลัพธ์ JSON ที่เข้มงวด สิ่งนี้รับประกันข้อมูลที่มีโครงสร้างสำหรับสายงานโปรแกรมมิ่ง เปิดใช้งานฟังก์ชันคอลลิงโดยส่งอาร์เรย์ tools ใน body ของคำขอ โมเดลจะส่งคืนการเรียกใช้เครื่องมือในรูปแบบที่คาดหวัง ใช้ tool_choice เพื่อบังคับพฤติกรรมเฉพาะ

5. อัตราการจำกัดและข้อจำกัดขนาดคำขอ

คีย์ API แต่ละตัวรองรับคำขอได้ 300 คำขอต่อนาที คำขอพร้อมกันจำกัดไว้ที่ 8 คำขอต่อคีย์ ขนาดสูงสุดของ body ในคำขอคือ 8 MB หน้าต่างบริบทรองรับ tokens ได้รวม 100,000 tokens ผลลัพธ์สูงสุดต่อคำขอคือเต็มหน้าต่าง 100,000 tokens ได้เลย ไม่ต้องตั้งค่า max_tokens หรือตั้งค่าให้สูงเพื่อหลีกเลี่ยงการตัดทอน ข้อผิดพลาดไม่ทำให้เครดิตหมด ไม่มีการคืนเงิน แต่หากมีข้อผิดพลาดในการเรียกเก็บเงิน สามารถแจ้งผ่านฝ่ายสนับสนุนได้

6. การตรวจสอบสิทธิ์และการจัดการข้อผิดพลาด

สร้างคีย์ของคุณผ่านแดชบอร์ด ใช้การเข้าสู่ระบบด้วย Google หรืออีเมล คีย์จะปรากฏทันที รวมคีย์ไว้ในส่วนหัว Authorization: Bearer คีย์ที่ไม่ถูกต้องจะส่งสถานะ 401 ข้อผิดพลาด 429 บ่งชี้ว่าหมดขีดจำกัดอัตราแล้ว ข้อผิดพลาด 402 หมายความว่าเครดิตที่ชำระล่วงหน้าของคุณหมดแล้ว เติมเงินด้วย USDT หรือ USDC เครดิตไม่มีวันหมดอายุ

การสตรีม

stream = 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)

Common queries

What is the uncensored ia model context window?

โมเดลรองรับหน้าต่างบริบทขนาด 100,000 token ซึ่งรวมถึงทั้ง prompt และ completion ไม่มีขีดจำกัด output แยกต่างหาก: การตอบกลับสามารถใช้พื้นที่ที่เหลือในหน้าต่างบริบทได้ทั้งหมด

How do I handle streaming responses in Python?

ตั้งค่าพารามิเตอร์ <code>stream</code> เป็น <code>true</code> ในคำขอของคุณ วนลูปผ่านออบเจกต์ response เพื่อประมวลผลแต่ละ chunk ใช้ SDK ทางการสำหรับการแยกวิเคราะห์ SSE อัตโนมัติ

What happens if I hit the rate limit?

API คืนค่าสถานะ 429 คุณสามารถลองใหม่หลังจากหยุดพักสั้นๆ คีย์แต่ละคีย์อนุญาตให้ส่งคำขอได้ 300 ครั้งต่อนาที หากต้องการเพิ่มความสามารถในการประมวลผลพร้อมกัน ให้สร้างคีย์เพิ่มเติมตามความจำเป็น

รับคีย์ของคุณตอนนี้

ลงทะเบียน รับคีย์ แล้วชี้ไปยัง endpoint ของเรา เสร็จแล้ว