Ana içeriğe geç

Asistan API Kullanımı

Bu sayfa, SkyStudio Assistant API entegrasyonunu anlatır.

1) API Key nereden alınır​

SkyStudio arayüzünde "Wokspace Settings / API Keys" alanından ilgili Assistant API için verilen API Key bilgilerini görüntüleyebilirsiniz.

2) API ayarları​

💡 Neden Bu Parametreleri Kullanıyoruz?​

  • Method: POST Çünkü sadece hazır bir veri okumuyoruz; işlenmesi için ona yeni bir soru veya dosya gönderiyoruz.

  • Auth: Bearer Token Sisteme giriş biletinizdir. API kullanmaya yetkili olduğunuzu kanıtlayan gizli güvenlik anahtarınızdır.

  • Headers: Content-Type: text/plain Gönderdiğimiz isteklerin tarayıcı güvenlik filtrelerine takılmadan, sunucuya en hızlı ve sorunsuz şekilde ulaşmasını sağlamak içindir.

  • Body: Raw, JSON Asistana soracağımız soruyu ve ayarları, sistemin en rahat okuyabildiği evrensel format olan JSON ile paketleyip gönderiyoruz.###

3) Örnek İstekler​

Endpoint​

MethodPathContent-Type
POST/api/v2text/plain

Full URL: https://skystudio.skymod.tech/api/v2

3.1) Dosyasız kullanım​

{
  "query": "E-mail imzası çıkmıyor?",
  "isStream": false,
  "citationType": "html"
}

3.2) Dosyalı kullanım (SkyStudio'ya yüklenmiş dosya adı/id ile)​

{
  "query": "Bu dosya ne hakkında?",
  "file": "IK_dataset_100.csv",
  "isStream": false,
  "citationType": "html"
}

3.3) Görsel URL ile kullanım​

{
  "query": "https://example.com/image.png Bu resimde ne görüyorsun?",
  "isStream": false,
  "citationType": "html"
}

4) Sorun Giderme​

Bir hata alırsanız önce:

  • URL doğru mu?
  • Auth Bearer token doğru mu?
  • Content-Type doğru mu?
  • Body formatı doğru mu?

Sonra status koduna göre: