API dokümantasyonu

Kimlik doğrulama ve base URL

Tüm istekler için temel URL https://api.grokapiplatform.com/v1. Benzersiz API anahtarınızı ileterek kimlik doğrulaması yapın. Authorization header. Her istek, hesap bakiyenizi doğrulamak ve hız sınırlamalarını uygulamak için bu başlığı içermelidir.

Sohbet tamamlamaları uç noktası

Metin sorgularını POST /v1/chat/completions. Kullanılacak model kimliği "uncensored"dir. Bu uç nokta, temel kullanım için ek yapılandırma gerektirmeden standart metin-girişi, metin-çıkışı etkileşimlerini yönetir.

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 100,000 token'lık bir bağlam penceresi ile çalışır. Girdi ve çıktı tokenları bu sınırı paylaşır. Bağlam penceresini aşan istekler hemen başarısız olur.

SSE ile akış yanıtlar

Ayarlayarak akışı etkinleştirin stream: true istemci gövnenizde. Sunucu, artımlı token güncellemeleri içeren Sunucu Tarafı Olayları (SSE) döndürür. Gerçek zamanlı görüntülemeler veya algılanan gecikmeyi azaltmak için bunu kullanın.

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)

Token kullanım detayları akışın son chunk'ında görünür. Her ara delta'yı ayrıştırmadan her istek için toplam tüketimi takip edebilirsiniz.

Fonksiyon çağırma ve araçlar

Araçları tools dizi ve ayarla tool_choice belirli davranışları tetiklemek için. Model, OpenAI SDK'larıyla uyumlu standart araç kullanma kalıplarını destekler.

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);

Kullan tool_choice: "auto" otomatik seçim için veya zorlu yürütme için bir araç adı belirtin. Bu, karmaşık akıl yürütme görevleri için sansürsüz modelle sorunsuz çalışır.

Yapılandırılmış çıktı için JSON modu

Ayarla response_format için {"type": "json_object"} katı JSON çıktısını zorlamak için. Bu, ön uç uygulamaları veya veri boruhatlarıyla entegrasyon sırasında ayrıştırma hatalarını azaltır.

Parameters and limits

Ayarla temperature, top_p, ve seed rastgeleliği kontrol etmek için. Her istek için maksimum çıktı 16.000 token'dir. 401 gibi hatalar geçersiz anahtarı, 402 yetersiz önceden ödenmiş krediyi ve 429 hız sınırlarını belirtir. Limit anahtar başına dakikada 300 istektir. Kredi süresi dolmaz, bu yüzden USDT veya USDC ile istediğiniz zaman yükleyebilirsiniz.

Akış

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)