API Dokümantasyonu
ISO 27001SOC 2 CertifiedGDPR Compliant

YZ Video Algılama API'si

TruthScan'in YZ video algılama API'sini uygulamalarınıza entegre etmek için eksiksiz dokümantasyon.

Kod yazmadan denemek için FastAPI üç noktamızı ziyaret edin: https://detect-video.truthscan.com/docs

Kimlik Doğrulama

TruthScan, API'ye erişim için API anahtarları kullanır. API anahtarınızı geliştirici portalımızın üst kısmında.

TruthScan, API anahtarının sunucuya yapılan tüm API isteklerinde aşağıdaki gibi bir istek gövdesinde yer almasını bekler:

{
  "key": "YOUR API KEY GOES HERE"
}

YOUR API KEY GOES HERE yazan yeri kişisel API anahtarınızla değiştirmelisiniz.

YZ Video Algılayıcı

Algılama (2 Adımlı Süreç)

YZ Video Algılama iş akışı aşağıdaki adımlardan oluşur:

  • Videoyu Algılama İçin Gönderin (multipart yükleme)
  • Sonuçları Almak İçin Isı Sorgulayın

1. Videoyu Algılama İçin Gönderin

Bir video dosyasını doğrudan API'ye yükleyin. Sunucu dosyayı doğrulayacaktır.

Desteklenen Dosya Formatları

MP4, MOV, AVI, MKV, WEBM

Dosya Boyutu Sınırları

  • Minimum dosya boyutu: 1KB
  • Maksimum dosya boyutu: 100MB
POST https://detect-video.truthscan.com/detect-file

Örnek İstek

curl -X POST \
  'https://detect-video.truthscan.com/detect-file' \
  -H 'accept: application/json' \
  -H 'key: YOUR-API-KEY-GOES-HERE' \
  -F 'file=@/path/to/video.mp4;type=video/mp4'

İsteğe Bağlı Parametreler

  • document_type: Belge türü (varsayılan: 'Video')
  • email: İşleme için isteğe bağlı e-posta adresi

Örnek Yanıt

{
    "id": "77565038-9e3d-4e6a-8c80-e20785be5ee9",
    "status": "pending"
}

Yanıt, algılama durumunu izlemek için benzersiz bir video kimliği içerir.

2. Algılama Durumunu ve Sonuçlarını Sorgulama

Gönderdikten sonra, durum ve sonuçları almak için kimlik ile /query üç noktasını sorgulayın.

POST https://detect-video.truthscan.com/query

Örnek İstek

curl -X POST 'https://detect-video.truthscan.com/query' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"id":"JOB-ID-GOES-HERE"}'

Örnek Yanıt

{
    "id": "bfd136fc-666b-42d0-89cf-0e9690c98f21",
    "status": "done",
    "result": 0.101969311406719,
    "result_details": {
        "final_stage": "watermark",
        "metadata": {
            "status": "ok",
            "prediction": "no_detection",
            "confidence": 0.0
        },
        "watermark": {
            "prediction": "ai_generated (watermark)",
            "confidence": 1.0
        },
        "ml": {
            "aggregate": {
                "prob_fake": 0.1019693114067195,
                "label": "cancelled",
                "n_frames": 256,
                "latency_sec": 23.319
            }
        },
        "latency_sec": 24.017
    },
    "preview_url": null
}

Sonuç Detayları

  • status: "pending", "analyzing", "done" veya "failed"
  • result: ML prob_fake'den türetilen [0.0, 1.0] araliginda skaler skor
  • final_stage: Sonuça katkı sağlayan son asama: 'metadata', 'watermark' veya 'ml'
  • metadata: Her zaman prediction: 'no_detection' ve confidence: 0.0 ayarlar. Durum 'reject', 'reencode' veya 'ok' olabilir
  • watermark: Kareleri ornekleyen ve piksel varyansından sahte güven hesaplayan sezgisel yöntem
  • ml: Örneklenmiş kareler üzerinde çalıştırılan sınıflandırıcı model. prob_fake [0.0, 1.0] araliginda ve etiket ('ai_generated' eger prob_fake >= 0.5, aksi halde 'no_detection') döndürür
  • latency_sec: Toplam pipeline süresi

"status" alani şu değerlerden biri olacaktır: "pending" (işleme sıraya alındı), "analyzing" (YZ algılama devam ediyor), "done" (sonuçlar mevcut) veya "failed" (işleme başarısız oldu).

Kullanıcı Kredilerini Kontrol Et

Bu üç nokta, başlık aracılığıyla kullanıcının apikey'ini kabul eder. Ve kullanıcının kredi ayrıntılarını döndürür.

GET https://detect-video.truthscan.com/check-user-credits

Örnek İstek

curl -X 'GET' \
  'https://detect-video.truthscan.com/check-user-credits' \
  -H 'apikey: YOUR API KEY GOES HERE' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json'

Örnek Yanıt

{
    "baseCredits": 10000,
    "boostCredits": 1000,
    "credits": 11000
}

Sağlık Kontrolü

API sunucusunun sağlık durumunu kontrol edin.

GET https://detect-video.truthscan.com/health

Örnek İstek

curl -X 'GET' \
  'https://detect-video.truthscan.com/health' \
  -H 'accept: application/json'

Örnek Yanıt

{
    "status": "healthy"
}

Hatalar

Hataların çoğu, API'ye yanlış parametreler gönderilmesinden kaynaklanır. Her API çağrısının parametrelerini doğru biçimlendirildiğinden emin olmak için iki kez kontrol edin ve sağlanan örnek kodu çalıştırmayı deneyin.

Kullandığımız genel hata kodları REST standardına uygundur:

Hata KoduAnlam
400Hatalı İstek -- İsteğiniz geçersiz.
403Yasak -- API anahtarı geçersiz veya video işleme için yeterli kredi yok.
404Bulunamadı -- Belirtilen kaynak mevcut değil.
405Yönteme İzin Verilmiyor -- Geçersiz bir yöntemle kaynağa erişmeye çalıştınız.
406Kabul Edilemez -- JSON olmayan bir format talep ettiniz.
410Kaldırıldı -- Bu üç noktadaki kaynak kaldırıldı.
422Geçersiz İstek Gövdesi -- İstek gövdeniz yanlış biçimlendirilmiş veya geçersiz veya eksik parametreleri var.
429Çok Fazla İstek -- Çok fazla istek gönderiyorsunuz! Yavaşlayın!
500Dahili Sunucu Hatası -- Sunucumuzda bir sorun yaşadık. Daha sonra tekrar deneyin.
503Hizmet Kullanım Dışı -- Bakım için geçici olarak çevrimdışıyız. Lütfen daha sonra tekrar deneyin.

Yaygın Sorunlar ve Çözümler

Kimlik Doğrulama Sorunları

"Kullanıcı doğrulaması başarısız oldu" (403)

Neden: Gecersiz veya süresi dolmus API anahtari

Çözüm:

  1. API anahtarınızın doğru olduğundan emin olun
  2. API anahtarınızın hesabınızda aktif olup olmadığını kontrol edin
  3. API anahtarınızı yeniden oluşturmayı deneyin

"Yeterli kredi yok" (403)

Neden: Video işleme için yetersiz kredi

Çözüm:

  1. Kalan kredilerinizi /check-user-credits ile kontrol edin
  2. Gerekirse ek kredi satın alın

Girdi Doğrulama Sorunları

"Desteklenmeyen video turu" (400)

Neden: Dosya formatı desteklenmiyor

Çözüm:

  1. Videoyu desteklenen formata dönüştürün (MP4, MOV, AVI, MKV, WEBM)
  2. Dosya uzantişinin ve MIME turinin doğru olduğundan emin olun

"Dosya boyutu siniri aşıyor" (400)

Neden: Video dosyası çok büyük

Çözüm:

  1. Boyutu azaltmak için videoyu sıkıştırın, kesin veya yeniden kodlayin (maksimum 100MB)
  2. Daha verimli bir codec/container kullanın

"Dosya boyutu çok küçük" (400)

Neden: Video dosyası minimum boyut gereksiniminin altında

Çözüm:

  1. Daha büyük bir video dosyası kullanın (minimum 1KB)
  2. Dosyanin yükleme sırasında bozulup bozulmadığını kontrol edin

"Gecersiz dosya turu" (400)

Neden: Dosya türü doğrulaması başarısız oldu (örneğin yanlış MIME türü veya bozuk dosya)

Çözüm:

  1. Dosyanın geçerli bir video formatı olduğundan emin olun
  2. MIME turinin dosya uzantisiyla esledigini doğrulayın
  3. Gerekirse dosyayi yeniden disari aktarin veya yeniden kodlayin

İşleme Sorunları

Video durumu "başarısız"

Neden: İşleme başarısız oldu (örneğin okunamaz container, kod çözme hataları)

Çözüm:

  1. Container/codec'in yaygin olarak desteklendiğinden emin olun (MP4 içinde H.264/AAC onerilir)
  2. Videoyu standart bir on ayar kullanarak yeniden kodlayin (örneğin ffmpeg) ve yeniden yükleyin
  3. Dosyanin boyut ve format gereksinimlerini karşıladigini doğrulayın

Video durumu "zaman aşımı" veya uzun işleme

Neden: Video işleme beklenenden daha uzun suruyor veya zaman aşımına ugradi

Çözüm:

  1. Biraz daha bekleyin ve /query kullanarak durumu tekrar kontrol edin
  2. Video dosyasının tüm format ve boyut gereksinimlerini karşıladigini doğrulayın
  3. Sorun devam ederse destekle iletişime geçin

"Kullanıcı bulunamadi"

Neden: Gecersiz kullanıcı kimliği

Çözüm:

  1. API anahtarınızın doğru olduğunu ve aktif bir hesaba bağlı olduğundan emin olun
  2. Entegrasyon kullanıcısının geçerli ve aktif olduğundan emin olun
  3. Gerekirse yeniden kimlik doğrulama yapin

"Dosya metadatasi alinamadi" (500)

Neden: Yuklenen dosyaya erisilemedi veya ayristirilamadi

Çözüm:

  1. Yüklemenin başarıyla tamamlandığını doğrulayın
  2. Dosyanin erisilebilir ve bozuk olmadığını kontrol edin
  3. Dosyayi yeniden yüklemeyi deneyin

Yardıma mı İhtiyacınız Var?

API'mizi kullanma veya teknik destek hakkında daha fazla bilgi için lütfen bizimle iletişime geçin.

Bize Ulaşın

API Sıkça Sorulan Sorular

YZ video algılama API'miz hakkında en sık sorulan soruların cevaplarını bulun.