api
Learn how to configure and use api in your project.
Folio API Documentation (v1)
Folio API, dijital ikizinizle (AI assistant) programatik olarak etkileşime geçmenizi sağlar. Bu dokümantasyon, API anahtarınızı nasıl alacağınızı, kimlik doğrulama sürecini ve mevcut uç noktaları (endpoints) kapsamaktadır.
🔐 Kimlik Doğrulama (Authentication)
Tüm API istekleri bir API anahtarı gerektirir. API anahtarınızı her isteğin başlığına (header) x-api-key olarak eklemelisiniz.
Örnek Header:
httpx-api-key: your_api_key_here
API Anahtarı Nasıl Alınır?
- Folio Dashboard'una giriş yapın.
- Sol menüden Settings > API Keys sekmesine gidin.
- "Generate New Key" butonuna tıklayarak anahtarınızı oluşturun.
- Anahtarınızı güvenli bir yerde saklayın (bir daha gösterilmeyebilir).
[!WARNING] API anahtarınız size özeldir. Asla istemci taraflı (browser) kodlarda veya halka açık depolarda (GitHub vb.) paylaşmayın.
🚀 Temel Uç Noktalar (Endpoints)
1. AI Sorgu (Query)
Dijital ikizinize soru sormak ve yanıt almak için kullanılır.
- URL:
/api/v1/query - Metot:
POST - İzinler: Premium Abonelik Gereklidir.
Request Body (JSON)
| Parametre | Tip | Zorunlu mu? | Açıklama |
|---|---|---|---|
question | String | Evet | AI'ya sorulan soru. |
history | Array | Hayır | Önceki konuşma geçmişi (Context için). |
Örnek İstek (curl):
bash curl -X POST https://twinly.me/api/v1/query \
-H "x-api-key: FL_123456789" \
-H "Content-Type: application/json" \
-d '{
"question": "Uzmanlık alanların nelerdir?",
"history": [
{"role": "user", "parts": "Merhaba!"},
{"role": "model", "parts": "Selam, size nasıl yardımcı olabilirim?"}
]
}'
Response Body (JSON)
json {
"response": "Benim uzmanlık alanlarım modern web teknolojileri, yapay zeka entegrasyonu ve...",
"usage": {
"remaining": 95,
"limit": 100
}
}
🚦 Limitler ve Kota (Rate Limiting)
Folio API, kötüye kullanımı önlemek ve adil kullanımı sağlamak için kotalar uygular:
- Günlük Limit: Abonelik planınıza göre değişir (Standart Premium için günlük 100 istek).
- Hata Mesajı: Kota dolduğunda API
429 Too Many Requestsyanıtı döner. - Kota Sıfırlanma: Her gün gece yarısı (00:00) kullanıcı bazlı sıfırlanır.
❌ Hata Kodları
| Durum Kodu | Mesaj | Çözüm |
|---|---|---|
401 Unauthorized | API key is required / Invalid API key | Header'da geçerli bir x-api-key olduğundan emin olun. |
403 Forbidden | Premium subscription required | Bu özellik için aktif bir Pro/Premium plana sahip olmalısınız. |
400 Bad Request | Question is required | Body içerisinde question parametresini gönderdiğinizden emin olun. |
429 Too Many Requests | Daily API limit reached | Günlük kotanız dolmuş. Bir sonraki gün sıfırlanmasını bekleyin. |
500 Internal Error | Internal server error | Sunucu tarafında bir hata oluştu. Lütfen teknik destek ile iletişime geçin. |
🛠️ SDK / Örnek Kullanım (JavaScript)
javascript async function askAI(question) {
const response = await fetch('https://twinly.me/api/v1/query', {
method: 'POST',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ question })
});
const data = await response.json();
if (response.ok) {
console.log("AI Yanıtı:", data.response);
} else {
console.error("Hata:", data.error);
}
}
Was this page helpful?
