Dokümantasyon / Başlarken
Uygulamanızı Clydex'ye bağlayın.
Responses'a bağlanın, istemcinizi yapılandırın ve uygulamanızda çalışan araçları ekleyin.
Başlamadan önce
- Bir anahtar oluşturun ve kopyalayın API anahtarları. Bunu özel tut.
- Mevcut bir modeli seçin Kanallar ve modeller. Onun yerine tam kimliğini kullanın
<MODEL_ID>aşağıda. - Aşağıda bir kılavuz açın. Değiştir
<YOUR_CLYDEX_API_KEY>anahtarınızla ve dosyaları kaydedin.
https://clydex.shop/v1Ayarların sizin için doldurulmasını mı istiyorsunuz? Tıklayın Anahtarı Kullan anahtar kartınızda uygulamanızı seçin ve yapılandırmasını kopyalayın veya indirin.
Başvurunuzu seçin
Codex CLI / App
Codex'yi iki dosyayla bağlayın.
- Dosya yöneticinizde ~/.codex'yi açın. Eksikse klasörü oluşturun.
- Ayarları config.toml olarak kaydedin. Üst düzey ayarları herhangi bir [bölüm] başlığının önüne koyun; diğer ayarlarınızı koruyun.
- auth.json'yi aynı klasöre kaydedin, ardından Codex'yi veya düzenleyicinizi yeniden başlatın ve yeni bir sohbet başlatın.
model_provider = "clydex"
model = "<MODEL_ID>"
disable_response_storage = true
cli_auth_credentials_store = "file"
web_search = "disabled"
[model_providers.clydex]
name = "Clydex"
base_url = "https://clydex.shop/v1"
wire_api = "responses"
requires_openai_auth = true
supports_websockets = false
request_max_retries = 0
stream_max_retries = 0{
"OPENAI_API_KEY": "<YOUR_CLYDEX_API_KEY>"
}Değiştirmeden önce mevcut auth.json'yi yedekleyin. Bu ayarlar aynı zamanda Codex IDE uzantısı için de geçerlidir.
OpenCode
Bir yapılandırma dosyası, ardından OpenCode'de Clydex'yi seçin.
- ~/.config/opencode'yi açın ve mevcut değilse opencode.json'yi oluşturun.
- Bu yapılandırmayı yapıştırın. Zaten bir yapılandırmanız varsa Clydex sağlayıcısını ve model ayarlarını bununla birleştirin.
- OpenCode'yi yeniden başlatın. /models komutunu çalıştırın ve Clydex altındaki modeli seçin.
{
"$schema": "https://opencode.ai/config.json",
"model": "clydex/<MODEL_ID>",
"small_model": "clydex/<MODEL_ID>",
"provider": {
"clydex": {
"npm": "@ai-sdk/openai",
"name": "Clydex",
"options": {
"baseURL": "https://clydex.shop/v1",
"apiKey": "<YOUR_CLYDEX_API_KEY>"
},
"models": {
"<MODEL_ID>": {
"name": "<MODEL_ID>",
"options": {
"store": false
}
}
}
}
}
}Herme'ler
Hermes'yi terminalinizden bağlayın.
- ~/.hermes/config.yaml dosyasını açın. Gerekirse klasörü ve dosyayı oluşturun.
- Model bölümünü bu ayarlarla değiştirin; yapılandırmanızın geri kalanını koruyun.
- Dosyayı kaydedin, Hermes'yi yeniden başlatın ve yeni bir görüşme başlatın.
model:
provider: custom
default: "<MODEL_ID>"
base_url: "https://clydex.shop/v1"
api_mode: codex_responses
api_key: "<YOUR_CLYDEX_API_KEY>"Cherry Studio
Cherry Studio ayarlarında Clydex'yi ekleyin.
- Ayarlar → Model Sağlayıcıları açın ve Clydex adlı bir sağlayıcı ekleyin.
- Uç nokta türü olarak OpenAI Responses'yi seçin. API adresini ve anahtarını aşağıya yapıştırın.
- <MODEL_ID> model kimliğini ekleyin, sağlayıcıyı etkinleştirin ve yeni bir sohbette bu modeli seçin.
https://clydex.shop/v1/<YOUR_CLYDEX_API_KEY><MODEL_ID>Web aramasını ve ekleri kapalı tutun. Eski sürümlerde sağlayıcı türüne OpenAI-Response adı verilir.
API / SDK'ler
Clydex anahtarınızı OpenAI SDK Responses API ile kullanın.
- Aşağıdaki Python, JavaScript veya terminal örneğini seçin.
- Python için pip install openai'yi, ardından python hello.py'yi çalıştırın. JavaScript için, npm install openai komutunu çalıştırın, ardından node hello.mjs'yi çalıştırın.
https://clydex.shop/v1from openai import OpenAI
client = OpenAI(
api_key="<YOUR_CLYDEX_API_KEY>",
base_url="https://clydex.shop/v1",
max_retries=0,
)
response = client.responses.create(
model="<MODEL_ID>",
input="Say hello in one sentence.",
max_output_tokens=128,
store=False,
)
print(response.output_text)import OpenAI from "openai";
const client = new OpenAI({
apiKey: "<YOUR_CLYDEX_API_KEY>",
baseURL: "https://clydex.shop/v1",
maxRetries: 0,
});
const response = await client.responses.create({
model: "<MODEL_ID>",
input: "Say hello in one sentence.",
max_output_tokens: 128,
store: false,
});
console.log(response.output_text);curl 'https://clydex.shop/v1/responses' \
-H 'Authorization: Bearer <YOUR_CLYDEX_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"model": "<MODEL_ID>",
"input": "Say hello in one sentence.",
"max_output_tokens": 128,
"store": false
}'Anahtarınızı içeren dosyaları gizli tutun. SDK örneklerini bilgisayarınızda veya sunucunuzda çalıştırın; asla genel tarayıcı kodunda çalıştırmayın.
İşlev araçları
İşlevleri şurada bildirin tools. Model bir çağrıya geri döner, uygulamanız onu yürütür ve siz de bir çağrı gönderirsiniz. function_call_output aynısıyla call_id. Aşağıdaki örnekte tam bir gidiş dönüş gösterilmektedir.
Python örneği: yerel bir işlev kullanın
İstemciyi kullanma hello.py yukarıda, isteğini bu örnekle değiştirin. En fazla iki model isteğinde bulunur ve yerel saat işlevini çalıştırır.
import json
import uuid
from datetime import datetime, timezone
history = [{"role": "user", "content": "What time is it in UTC?"}]
tools = [{
"type": "function",
"name": "get_utc_time",
"description": "Return the current UTC time.",
"parameters": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": False,
},
"strict": True,
}]
first = client.responses.create(
model="<MODEL_ID>", input=history, tools=tools,
tool_choice={"type": "function", "name": "get_utc_time"},
parallel_tool_calls=False,
include=["reasoning.encrypted_content"],
max_output_tokens=256, store=False,
extra_headers={"Idempotency-Key": str(uuid.uuid4())},
)
history.extend(item.model_dump(exclude_none=True) for item in first.output)
calls = [item for item in first.output if item.type == "function_call"]
if len(calls) != 1 or calls[0].name != "get_utc_time":
raise RuntimeError("Expected one get_utc_time call; check the response.")
call = calls[0]
if json.loads(call.arguments) != {}:
raise RuntimeError("Unexpected function arguments.")
history.append({
"type": "function_call_output",
"call_id": call.call_id,
"output": json.dumps({"utc": datetime.now(timezone.utc).isoformat()}),
})
final = client.responses.create(
model="<MODEL_ID>", input=history, tools=tools, tool_choice="none",
include=["reasoning.encrypted_content"],
max_output_tokens=256, store=False,
extra_headers={"Idempotency-Key": str(uuid.uuid4())},
)
print(final.output_text)Bir sonraki turu oluştururken, akıl yürütme öğeleri de dahil olmak üzere döndürülen çıktı öğelerini koruyun. Bir işlevi çalıştırmadan önce uygulamanızdaki araç adlarını ve bağımsız değişkenleri doğrulayın. Özel araçların kullanımı custom_tool_call ve custom_tool_call_output aynı çağrı/sonuç modeliyle.
Daha fazla yardım
Akış ve istek seçenekleri
Ayarla stream: true HTTP üzerinden yayınlanan Yanıtlar için. Araç çağrısı argümanları çeşitli olaylarla gelebilir; çağrıyı gerçekleştirmeden önce tüm çağrıyı birleştirin. Son kullanım terminal yanıt olayında gelir. WebSocket aktarımı kullanılamıyor.
Ayarla max_output_tokens İstediğiniz çıkış uzunluğu için. Bu garantili bir harcama sınırı değildir. Muhakeme seçenekleri, metin ayrıntı düzeyi ve yapılandırılmış metin biçimleri, seçilen modelin bunları desteklemesi durumunda kabul edilir. Depolamayı kapalı tutun ve her fırsatta konuşma geçmişinin tamamını gönderin.
Bir istek işe yaramadı
- Anahtarın aktif olup olmadığını ve bakiyesinde kredi olup olmadığını kontrol edin.
- Bu model için mevcut bir model kimliğini ve doğru uç noktayı kullanın.
- Desteklenmeyen alan hatası için hatada adı geçen seçeneği kaldırın. Uygulamanız her zaman gönderiyorsa, API örneği.
- Bir zaman aşımından sonra kontrol edin istek geçmişi tekrar denemeden önce.
Kullanımınızı ve ücretlerinizi bulma
Açık istek geçmişi istek durumunu, belirteçleri ve maliyeti görmek için. Bekleyen istekler hâlâ kontrol ediliyor. Bkz. İstatistikler toplamlar için veya Modeller ve fiyatlar oranlar için.