Dokumentasi API

Pengesahan dan url asas

URL asas untuk semua permintaan ialah https://api.grokapiplatform.com/v1. Sahkan dengan menghantar kunci API unik anda dalam Authorization header. Setiap permintaan mesti termasuk header ini untuk mengesahkan baki akaun anda dan mengenakan had kadar.

Hujung sambungan penyelesaian sembang

Hantar pertanyaan teks ke POST /v1/chat/completions. ID model yang perlu digunakan ialah "uncensored". Hujung ini mengendalikan interaksi teks masuk dan teks keluar piawai tanpa memerlukan konfigurasi tambahan untuk penggunaan asas.

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."}]
  }'

Model ini beroperasi dengan tetingkap konteks 100,000 token. Token input dan output berkongsi had ini. Permintaan yang melebihi tetingkap konteks akan gagal serta-merta.

Respons penstriman dengan SSE

Aktifkan aliran dengan menetapkan stream: true dalam badan permintaan anda. Pelayan mengembalikan Acara yang Dihantar Pelayan (SSE) dengan kemas kini token berperingkat. Gunakan ini untuk paparan masa nyata atau untuk mengurangkan latensi yang dirasakan.

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)

Butiran penggunaan token muncul dalam potongan akhir aliran. Anda boleh mengesan jumlah penggunaan bagi setiap permintaan tanpa menguraikan setiap delta antara.

Pemanggilan fungsi dan alat

Takrifkan alat dalam tools array and set tool_choice untuk mencetuskan tingkah laku tertentu. Model menyokong corak penggunaan alat standard yang serasi dengan 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);

Gunakan tool_choice: "auto" untuk pemilihan automatik atau nyatakan nama alat untuk pelaksanaan paksa. Ini berfungsi dengan lancar dengan model tanpa sensor untuk tugas penalaran kompleks.

Mod JSON untuk output terstruktur

Tetapkan response_format ke {"type": "json_object"} untuk memaksakan output JSON yang ketat. Ini mengurangkan ralat penguraan apabila berintegrasi dengan aplikasi frontend atau saluran data.

Parameter dan had

Laraskan temperature, top_p, dan seed untuk mengawal rawakan. Output maksimum setiap permintaan ialah 16,000 token. Ralat seperti 401 menunjukkan kunci tidak sah, 402 bermaksud kredit prabayar tidak mencukupi, dan 429 menandakan had kadar. Hadnya ialah 300 permintaan setiap minit per kunci. Kredit tidak luput, jadi anda boleh menambah baki dengan USDT atau USDC bila-bila masa diperlukan.

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)