เอกสาร API

Authentication and base URL

URL พื้นฐานสำหรับคำขอทั้งหมดคือ https://api.grokapiplatform.com/v1. ทำการตรวจสอบสิทธิ์โดยส่ง API key เฉพาะของคุณใน Authorization header ทุกคำขอต้องรวม header นี้เพื่อตรวจสอบยอดเงินบัญชีของคุณและกำหนดขีดจำกัดอัตรา

จุดจบ API Chat completions

ส่งคำสอบถามข้อความไปยัง POST /v1/chat/completions. รหัสโมเดลที่ใช้คือ "uncensored" จุดปลายทางนี้จัดการการโต้ตอบแบบข้อความเข้า-ข้อความออกมาตรฐาน โดยไม่ต้องกำหนดค่าเพิ่มเติมสำหรับการใช้งานพื้นฐาน

Copycurl https://api.grokapiplatform.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check my current token usage balance."}]
  }'

โมเดลนี้ทำงานด้วยหน้าต่างบริบท 100,000 token โทเค็นอินพุตและเอาต์พุตแบ่งปันขีดจำกัดนี้ คำขอที่เกินหน้าต่างบริบทจะล้มเหลวทันที

การตอบกลับแบบสตรีมด้วย SSE

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true ในบอดีคำขอของคุณ เซิร์ฟเวอร์จะส่งคืนเหตุการณ์ที่ส่งจากเซิร์ฟเวอร์ (SSE) พร้อมอัปเดตโทเค็นเพิ่มเติม ใช้วิธีนี้สำหรับการแสดงผลแบบเรียลไทม์หรือเพื่อลดความล่าช้าที่รับรู้ได้

Copyfrom openai import OpenAI

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

รายละเอียดการใช้งานโทเค็นปรากฏในชิ้นสุดท้ายของสตรีม คุณสามารถติดตามการบริโภคทั้งหมดต่อคำขอโดยไม่ต้องแยกวิเคราะห์แต่ละเดลต้า

การเรียกฟังก์ชันและเครื่องมือ

กำหนดเครื่องมือใน tools อาร์เรย์และตั้งค่า tool_choice เพื่อกระตุ้นพฤติกรรมเฉพาะ โมเดลรองรับรูปแบบการใช้เครื่องมือมาตรฐานที่เข้ากันได้กับ SDK ของ OpenAI

Copyimport OpenAI from "openai";

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

ใช้ tool_choice: "auto" สำหรับการเลือกอัตโนมัติหรือระบุชื่อเครื่องมือสำหรับการบังคับดำเนินการ วิธีนี้ทำงานร่วมกันได้อย่างราบรื่นกับโมเดล uncensored สำหรับงานการให้เหตุผลที่ซับซ้อน

โหมด JSON สำหรับผลลัพธ์ที่มีโครงสร้าง

ตั้งค่า response_format เพื่อ {"type": "json_object"} เพื่อบังคับใช้เอาต์พุต JSON อย่างเข้มงวด สิ่งนี้ลดข้อผิดพลาดในการแยกวิเคราะห์เมื่อผสานรวมกับแอปพลิเคชันหน้าบ้านหรือสายงานข้อมูล

Parameters and limits

ปรับ temperature, top_p, และ seed เพื่อควบคุมความสุ่ม ผลลัพธ์สูงสุดต่อคำขอคือ 16,000 โทเค็น ข้อผิดพลาดเช่น 401 บ่งชี้คีย์ไม่ถูกต้อง 402 หมายถึงเครดิตพรีเพย์ไม่เพียงพอ และ 429 แจ้งเตือนขีดจำกัดอัตรา คำขอสูงสุดคือ 300 คำขอต่อนาทีต่อคีย์ เครดิตไม่หมดอายุ ดังนั้นคุณสามารถเติมเงินด้วย USDT หรือ USDC ได้ whenever ต้องการ

การสตรีม

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)