API Dokümantasyonu: Hızlı Başlangıç Rehberi

Temel URL ve Kimlik Doğrulama

Heretic AI API'si tamamen OpenAI-uyumludur. İstemcinizi base URL'mize işaret ederek etkileşime geçersiniz: https://api.hereticai.cc/v1. Kimlik doğrulama, Google veya e-posta ile kayıt olduğunuzda anında oluşturulan ve hesap başına tek bir API anahtarına dayanır. Bu anahtarı ile geçirin. Authorization üstbilgiyi Bearer token olarak kullanın. Model tanımlayıcısı basitçe uncensored. Bu tek model, tüm isteklerinizi yönlendirme karmaşası olmadan yönetir. 401 hataları geçersiz bir anahtarı, 402 hataları ise daha fazla ön ödemeli kripto kredisi ihtiyacınızı gösterir.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

Sohbet Tamamlamaları Uç Noktası

Standart kullanarak metin istekleri gönderin POST /v1/chat/completions endpoint. API, konuşma geçmişinizi veya isteminizi içeren standart bir mesaj dizisi bekler. Oluşturulan metni choices dizi. Bu, saf bir yardımcı program API'sidir: metin girişi, metin çıkışı. Tüketilen tokenlar için ödeme yaparsınız. Ön ödemeli kredi süresi dolmaz, reddetmeler veya hatalar token maliyeti yaratmaz. Bu yaklaşım, abonelik kilitlerini ve öngörülemez ücretsiz katmanları ortadan kaldırır.

Copyfrom openai import OpenAI

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

Akış Yanıtları (SSE)

Gerçek zamanlı token akışını etkinleştirmek için stream: true istekinizde. API, oluşturulan her token için Sunucu Tarafından Gönderilen Etkinlikler (SSE) döndürür. Bu, çıktıyı aşamalı olarak görüntülemenizi sağlar ki bu da gecikme duyarlı uygulamalar için kritiktir. Token kullanım istatistikleri, akışın son parçasında görünür. Bu özellik, SSE'leri otomatik olarak işleyen standart OpenAI SDK'larıyla sorunsuz çalışır. Tam tamamlanmayı beklemeksizin anında geri bildirim sağlar.

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)

Fonksiyon Çağırma ve Araçlar

API, tools ve tool_choice parametreler. İstek araç şemalarınızı tanımlayın ve model uygun olduğunda yapılandırılmış fonksiyon çağrıları döndürür. Bu, LLM'nin bir sonraki eylemi hangi yönde alacağını belirlediği karmaşık iş akışlarını mümkün kılar. Belirli araç kullanımını zorlayabilir veya modelin özgürce seçmesine izin verebilirsiniz. Bu yetenek, harici sistemlerle veya veritabanlarıyla etkileşim kuran ajan uygulamaları oluşturmak için temel öneme sahiptir.

JSON Modu

Deterministik çıktı sağlamak için ayarlayın response_format için {"type": "json_object"}. Model yanıtını geçerli JSON ile sınırlar; bu, programatik ayrıştırma için hayati önem taşır. Bu, son işleme regex düzeltmelerine olan ihtiyacı azaltır. Çıktının doğrudan kodunuz tarafından tüketilebileceğini garanti eder. Bu, özellikle yapılandırılmış veri çıkarma veya yapılandırma üretme görevleri için kullanışlıdır.

Parameters and Limits

temperature gibi standart parametreleri kullanarak üretimi kontrol edin temperature, top_p, ve seed. Bağlam penceresi, istem ve tamamlama için 100.000 token'dır. Maksimum çıktı istek başına 16.000 token'dır veya max_tokens ayarlanmamıştır. Hız sınırları dakikada 300 istek ve anahtar başına 8 eşzamanlı istektir. İstek gövdesi 8 MB'ın altında kalmalıdır. Bu sınırlar, geliştiriciler için yüksek hacimli kullanımda kararlılığı sağlar.

Node.js

Copyimport OpenAI from "openai";

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