GET /documents

این endpoint چه می‌کند؟

اسناد را با فیلترهای catalog و pagination فهرست می‌کند.

احراز هویت

عمومی یا مجاز بر اساس visibility. API رکوردهای خارج از scope را در پاسخ، search و direct ID نمایش نمی‌دهد.

پارامترها

نام	محل	نوع	الزامی	توضیح
category	query	string	خیر	یکی از دسته‌های معتبر catalog.
type	query	string	خیر	نوع دانش؛ برای media معمولاً screenshot.
visibility	query	string	خیر	PUBLIC، INTERNAL، MANAGEMENT یا RESTRICTED؛ private filter مجوز می‌خواهد.
language	query	string	خیر	کد زبان مانند fa یا en.
tag	query	string	خیر	برچسب کوچک حروف‌کوچک و خط تیره.
status	query	string	خیر	وضعیت رکورد؛ media به‌طور پیش‌فرض current است.
updated_after	query	ISO date	خیر	رکوردهای به‌روزشده بعد از این زمان.
limit	query	integer	خیر	پیش‌فرض ۲۰ و حداکثر ۱۰۰.
cursor	query	string	خیر	offset opaque برای صفحهٔ بعد؛ nextCursor را دوباره ارسال کنید.

نمونهٔ درخواست

cURL

curl "https://luma-knowledge.pages.dev/api/v1/documents"

نمونهٔ پاسخ

JSON

{
  "data": [{"id": "faq", "kind": "document", "title": "پرسش‌های متداول لوما"}],
  "pagination": {"limit": 20, "cursor": "0", "nextCursor": null, "total": 1}
}

خطاهای مرتبط

400 invalid_query برای query نامعتبر و 404 not_found برای resource غیرقابل مشاهدهٔ احتمالی برگردانده می‌شود. شکل خطا در راهنمای خطا آمده است.

Try it

فقط درخواست GET عمومی؛ credential در مرورگر استفاده نمی‌شود.

جست‌وجو در دانش لوما

دانش لوما

فهرست اسناد