İçeriğe Geç

Dokümanları Listele

GET /api/v1/documents

Dokümanları Listele

Boru hattını tamamlamış (PipelineStatus = Completed) dokümanları sayfalı olarak döner. Eksik, metin çıkarma aşamasında takılmış veya AI analizi bekleyen dokümanlar bu listede görünmez. Ayrıca varsayılan olarak yalnızca yürürlükteki mevzuat listelenir — mülga belgeler için legalStatus parametresini kullanın. Yanıt pagination zarfı ile birlikte gelir.

Filtreleme

filter parametresi belge başlığında ve AI özetinde alt-dize araması yapar ve büyük/küçük harfe duyarlıdırKripto ile kripto aynı sonucu vermez. /search/keyword aynı alt-dize eşleşmesini POST gövdesiyle ve maxResults parametresiyle sunar; farklı bir arama motoru değildir. Kavramsal/anlamsal arama için /library/semantic uç noktasını kullanın.

startDate ve endDate yayım tarihini (publishedDate) sınırlar. Her iki sınır dahildir ve ISO 8601 formatında beklenir. Saat dilimi eksikse UTC varsayılır.

sourceId parametresi /sources uç noktasından aldığınız kimliktir.

Yürürlük durumu

Varsayılan olarak yalnızca yürürlükteki mevzuat döner; mülga belgeler listede görünmez. Değişmiş/tadil edilmiş belgeler yürürlükte sayılır ve dönmeye devam eder. Mülga belgeleri de görmek için legalStatus=all, yalnızca mülga olanlar için legalStatus=mulga gönderin.

Bu süzgeç pagination.totalCount değerine de uygulanır — kurum genelindeki toplam belge sayısıyla karşılaştırma yaparken bunu hesaba katın.

Sayfalama

  • page 1'den başlar — page=0 otomatik olarak 1'e yuvarlanır.
  • pageSize 1-100 arasıdır; 100'ün üstü 100'e kapanır. Varsayılan 20.
  • pagination.totalCount filtreli toplam kayıt sayısıdır; gerçek bir sayıdır (tahmin değil).

Her belgenin AI özeti, sınıflandırması ve yükümlülükleri için /documents/{id} uç noktasını kullanın. Detay yanıtı belgenin metnini içermez: çıkarılmış tam metin için /library/{id}/text, orijinal dosya için /documents/{id}/download uç noktasına gidin.

Parametreler

İsimKonumTipZorunluAçıklama
sourceId Query uuid Hayır Belirli bir kaynakla sınırlandır.
filter Query string Hayır Başlık ve AI özetinde alt-dize araması (büyük/küçük harfe duyarlı).
startDate Query date-time Hayır Yayım tarihi alt sınırı (ISO 8601).
endDate Query date-time Hayır Yayım tarihi üst sınırı (ISO 8601).
legalStatus Query string Hayır Yürürlük süzgeci: `all` = tümü, `mulga` = yalnızca mülga belgeler, boş/diğer = yalnızca yürürlükteki belgeler (varsayılan).
page Query integer Hayır Sayfa numarası (1'den başlar).
pageSize Query integer Hayır Sayfa başına öğe sayısı (1-100).

Yanıtlar

200 — Başarılı — pagination zarfı ile birlikte liste.

{
  "success": true,
  "data": [
    {
      "id": "7a3f9e2c-...",
      "title": "Kripto Varlık Hizmet Sağlayıcıları Hakkında Yönetmelik",
      "sourceName": "Resmi Gazete",
      "publishedDate": "2026-03-28T00:00:00Z",
      "documentFormat": 0,
      "sourceUrl": "https://..."
    }
  ],
  "pagination": { "page": 1, "pageSize": 20, "totalCount": 42 }
}